docs/perltidy.html

   1 <?xml version="1.0" ?>
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
   3 <html xmlns="http://www.w3.org/1999/xhtml">
   4 <head>
   5 <title></title>
   6 <meta http-equiv="content-type" content="text/html; charset=utf-8" />
   7 <link rev="made" href="mailto:root@localhost" />
   8 </head>
   9
  10 <body>
  11
  12
  13
  14 <ul id="index">
  15   <li><a href="#NAME">NAME</a></li>
  16   <li><a href="#SYNOPSIS">SYNOPSIS</a></li>
  17   <li><a href="#DESCRIPTION">DESCRIPTION</a></li>
  18   <li><a href="#EXAMPLES">EXAMPLES</a></li>
  19   <li><a href="#OPTIONS---OVERVIEW">OPTIONS - OVERVIEW</a>
  20     <ul>
  21       <li><a href="#I-O-Control">I/O Control</a></li>
  22     </ul>
  23   </li>
  24   <li><a href="#FORMATTING-OPTIONS">FORMATTING OPTIONS</a>
  25     <ul>
  26       <li><a href="#Basic-Options">Basic Options</a></li>
  27       <li><a href="#Code-Indentation-Control">Code Indentation Control</a></li>
  28       <li><a href="#Whitespace-Control">Whitespace Control</a></li>
  29       <li><a href="#Comment-Controls">Comment Controls</a></li>
  30       <li><a href="#Skipping-Selected-Sections-of-Code">Skipping Selected Sections of Code</a></li>
  31       <li><a href="#Line-Break-Control">Line Break Control</a></li>
  32       <li><a href="#Controlling-Breaks-at-Braces-Parens-and-Square-Brackets">Controlling Breaks at Braces, Parens, and Square Brackets</a></li>
  33       <li><a href="#Welding">Welding</a></li>
  34       <li><a href="#Breaking-Before-or-After-Operators">Breaking Before or After Operators</a></li>
  35       <li><a href="#Controlling-List-Formatting">Controlling List Formatting</a></li>
  36       <li><a href="#Adding-and-Deleting-Commas">Adding and Deleting Commas</a></li>
  37       <li><a href="#Retaining-or-Ignoring-Existing-Line-Breaks">Retaining or Ignoring Existing Line Breaks</a></li>
  38       <li><a href="#Blank-Line-Control">Blank Line Control</a></li>
  39       <li><a href="#Styles">Styles</a></li>
  40       <li><a href="#One-Line-Blocks">One-Line Blocks</a></li>
  41       <li><a href="#Controlling-Vertical-Alignment">Controlling Vertical Alignment</a></li>
  42       <li><a href="#Extended-Syntax">Extended Syntax</a></li>
  43       <li><a href="#Other-Controls">Other Controls</a></li>
  44     </ul>
  45   </li>
  46   <li><a href="#HTML-OPTIONS">HTML OPTIONS</a></li>
  47   <li><a href="#SOME-COMMON-INPUT-CONVENTIONS">SOME COMMON INPUT CONVENTIONS</a>
  48     <ul>
  49       <li><a href="#Specifying-Block-Types">Specifying Block Types</a></li>
  50       <li><a href="#Specifying-File-Extensions">Specifying File Extensions</a></li>
  51     </ul>
  52   </li>
  53   <li><a href="#SWITCHES-WHICH-MAY-BE-NEGATED">SWITCHES WHICH MAY BE NEGATED</a></li>
  54   <li><a href="#LIMITATIONS">LIMITATIONS</a></li>
  55   <li><a href="#FILES">FILES</a></li>
  56   <li><a href="#ERROR-HANDLING">ERROR HANDLING</a></li>
  57   <li><a href="#SEE-ALSO">SEE ALSO</a></li>
  58   <li><a href="#INSTALLATION">INSTALLATION</a></li>
  59   <li><a href="#VERSION">VERSION</a></li>
  60   <li><a href="#BUG-REPORTS">BUG REPORTS</a></li>
  61   <li><a href="#COPYRIGHT">COPYRIGHT</a></li>
  62   <li><a href="#LICENSE">LICENSE</a></li>
  63   <li><a href="#DISCLAIMER">DISCLAIMER</a></li>
  64 </ul>
  65
  66 <h1 id="NAME">NAME</h1>
  67
  68 <p>perltidy - a perl script indenter and reformatter</p>
  69
  70 <h1 id="SYNOPSIS">SYNOPSIS</h1>
  71
  72 <pre><code>    perltidy [ options ] file1 file2 file3 ...
  73             (output goes to file1.tdy, file2.tdy, file3.tdy, ...)
  74     perltidy [ options ] file1 -o outfile
  75     perltidy [ options ] file1 -st &gt;outfile
  76     perltidy [ options ] &lt;infile &gt;outfile</code></pre>
  77
  78 <h1 id="DESCRIPTION">DESCRIPTION</h1>
  79
  80 <p>Perltidy reads a perl script and writes an indented, reformatted script. The formatting process involves converting the script into a string of tokens, removing any non-essential whitespace, and then rewriting the string of tokens with whitespace using whatever rules are specified, or defaults. This happens in a series of operations which can be controlled with the parameters described in this document.</p>
  81
  82 <p>Perltidy is a commandline frontend to the module Perl::Tidy. For documentation describing how to call the Perl::Tidy module from other applications see the separate documentation for Perl::Tidy. It is the file Perl::Tidy.pod in the source distribution.</p>
  83
  84 <p>Many users will find enough information in <a href="#EXAMPLES">&quot;EXAMPLES&quot;</a> to get started. New users may benefit from the short tutorial which can be found at http://perltidy.sourceforge.net/tutorial.html</p>
  85
  86 <p>A convenient aid to systematically defining a set of style parameters can be found at http://perltidy.sourceforge.net/stylekey.html</p>
  87
  88 <p>Perltidy can produce output on either of two modes, depending on the existence of an <b>-html</b> flag. Without this flag, the output is passed through a formatter. The default formatting tries to follow the recommendations in perlstyle(1), but it can be controlled in detail with numerous input parameters, which are described in <a href="#FORMATTING-OPTIONS">&quot;FORMATTING OPTIONS&quot;</a>.</p>
  89
  90 <p>When the <b>-html</b> flag is given, the output is passed through an HTML formatter which is described in <a href="#HTML-OPTIONS">&quot;HTML OPTIONS&quot;</a>.</p>
  91
  92 <h1 id="EXAMPLES">EXAMPLES</h1>
  93
  94 <pre><code>  perltidy somefile.pl</code></pre>
  95
  96 <p>This will produce a file <i>somefile.pl.tdy</i> containing the script reformatted using the default options, which approximate the style suggested in perlstyle(1). The source file <i>somefile.pl</i> is unchanged.</p>
  97
  98 <pre><code>  perltidy *.pl</code></pre>
  99
 100 <p>Execute perltidy on all <i>.pl</i> files in the current directory with the default options. The output will be in files with an appended <i>.tdy</i> extension. For any file with an error, there will be a file with extension <i>.ERR</i>.</p>
 101
 102 <pre><code>  perltidy -b file1.pl file2.pl</code></pre>
 103
 104 <p>Modify <i>file1.pl</i> and <i>file2.pl</i> in place, and backup the originals to <i>file1.pl.bak</i> and <i>file2.pl.bak</i>. If <i>file1.pl.bak</i> and/or <i>file2.pl.bak</i> already exist, they will be overwritten.</p>
 105
 106 <pre><code>  perltidy -b -bext=&#39;/&#39; file1.pl file2.pl</code></pre>
 107
 108 <p>Same as the previous example except that the backup files <i>file1.pl.bak</i> and <i>file2.pl.bak</i> will be deleted if there are no errors.</p>
 109
 110 <pre><code>  perltidy -gnu somefile.pl</code></pre>
 111
 112 <p>Execute perltidy on file <i>somefile.pl</i> with a style which approximates the GNU Coding Standards for C programs. The output will be <i>somefile.pl.tdy</i>.</p>
 113
 114 <pre><code>  perltidy -i=3 somefile.pl</code></pre>
 115
 116 <p>Execute perltidy on file <i>somefile.pl</i>, with 3 columns for each level of indentation (<b>-i=3</b>) instead of the default 4 columns. There will not be any tabs in the reformatted script, except for any which already exist in comments, pod documents, quotes, and here documents. Output will be <i>somefile.pl.tdy</i>.</p>
 117
 118 <pre><code>  perltidy -i=3 -et=8 somefile.pl</code></pre>
 119
 120 <p>Same as the previous example, except that leading whitespace will be entabbed with one tab character per 8 spaces.</p>
 121
 122 <pre><code>  perltidy -ce -l=72 somefile.pl</code></pre>
 123
 124 <p>Execute perltidy on file <i>somefile.pl</i> with all defaults except use &quot;cuddled elses&quot; (<b>-ce</b>) and a maximum line length of 72 columns (<b>-l=72</b>) instead of the default 80 columns.</p>
 125
 126 <pre><code>  perltidy -g somefile.pl</code></pre>
 127
 128 <p>Execute perltidy on file <i>somefile.pl</i> and save a log file <i>somefile.pl.LOG</i> which shows the nesting of braces, parentheses, and square brackets at the start of every line.</p>
 129
 130 <pre><code>  perltidy -html somefile.pl</code></pre>
 131
 132 <p>This will produce a file <i>somefile.pl.html</i> containing the script with html markup. The output file will contain an embedded style sheet in the &lt;HEAD&gt; section which may be edited to change the appearance.</p>
 133
 134 <pre><code>  perltidy -html -css=mystyle.css somefile.pl</code></pre>
 135
 136 <p>This will produce a file <i>somefile.pl.html</i> containing the script with html markup. This output file will contain a link to a separate style sheet file <i>mystyle.css</i>. If the file <i>mystyle.css</i> does not exist, it will be created. If it exists, it will not be overwritten.</p>
 137
 138 <pre><code>  perltidy -html -pre somefile.pl</code></pre>
 139
 140 <p>Write an html snippet with only the PRE section to <i>somefile.pl.html</i>. This is useful when code snippets are being formatted for inclusion in a larger web page. No style sheet will be written in this case.</p>
 141
 142 <pre><code>  perltidy -html -ss &gt;mystyle.css</code></pre>
 143
 144 <p>Write a style sheet to <i>mystyle.css</i> and exit.</p>
 145
 146 <pre><code>  perltidy -html -frm mymodule.pm</code></pre>
 147
 148 <p>Write html with a frame holding a table of contents and the source code. The output files will be <i>mymodule.pm.html</i> (the frame), <i>mymodule.pm.toc.html</i> (the table of contents), and <i>mymodule.pm.src.html</i> (the source code).</p>
 149
 150 <h1 id="OPTIONS---OVERVIEW">OPTIONS - OVERVIEW</h1>
 151
 152 <p>The entire command line is scanned for options, and they are processed before any files are processed. As a result, it does not matter whether flags are before or after any filenames. However, the relative order of parameters is important, with later parameters overriding the values of earlier parameters.</p>
 153
 154 <p>For each parameter, there is a long name and a short name. The short names are convenient for keyboard input, while the long names are self-documenting and therefore useful in scripts. It is customary to use two leading dashes for long names, but one may be used.</p>
 155
 156 <p>Most parameters which serve as on/off flags can be negated with a leading &quot;n&quot; (for the short name) or a leading &quot;no&quot; or &quot;no-&quot; (for the long name). For example, the flag to outdent long quotes is <b>-olq</b> or <b>--outdent-long-quotes</b>. The flag to skip this is <b>-nolq</b> or <b>--nooutdent-long-quotes</b> or <b>--no-outdent-long-quotes</b>.</p>
 157
 158 <p>Options may not be bundled together. In other words, options <b>-q</b> and <b>-g</b> may NOT be entered as <b>-qg</b>.</p>
 159
 160 <p>Option names may be terminated early as long as they are uniquely identified. For example, instead of <b>--dump-token-types</b>, it would be sufficient to enter <b>--dump-tok</b>, or even <b>--dump-t</b>, to uniquely identify this command.</p>
 161
 162 <h2 id="I-O-Control">I/O Control</h2>
 163
 164 <p>The following parameters concern the files which are read and written.</p>
 165
 166 <dl>
 167
 168 <dt id="h---help"><b>-h</b>, <b>--help</b></dt>
 169 <dd>
 170
 171 <p>Show summary of usage and exit.</p>
 172
 173 </dd>
 174 <dt id="o-filename---outfile-filename"><b>-o</b>=filename, <b>--outfile</b>=filename</dt>
 175 <dd>
 176
 177 <p>Name of the output file (only if a single input file is being processed). If no output file is specified, and output is not redirected to the standard output (see <b>-st</b>), the output will go to <i>filename.tdy</i>. [Note: - does not redirect to standard output. Use <b>-st</b> instead.]</p>
 178
 179 </dd>
 180 <dt id="st---standard-output"><b>-st</b>, <b>--standard-output</b></dt>
 181 <dd>
 182
 183 <p>Perltidy must be able to operate on an arbitrarily large number of files in a single run, with each output being directed to a different output file. Obviously this would conflict with outputting to the single standard output device, so a special flag, <b>-st</b>, is required to request outputting to the standard output. For example,</p>
 184
 185 <pre><code>  perltidy somefile.pl -st &gt;somefile.new.pl</code></pre>
 186
 187 <p>This option may only be used if there is just a single input file. The default is <b>-nst</b> or <b>--nostandard-output</b>.</p>
 188
 189 </dd>
 190 <dt id="se---standard-error-output"><b>-se</b>, <b>--standard-error-output</b></dt>
 191 <dd>
 192
 193 <p>If perltidy detects an error when processing file <i>somefile.pl</i>, its default behavior is to write error messages to file <i>somefile.pl.ERR</i>. Use <b>-se</b> to cause all error messages to be sent to the standard error output stream instead. This directive may be negated with <b>-nse</b>. Thus, you may place <b>-se</b> in a <i>.perltidyrc</i> and override it when desired with <b>-nse</b> on the command line.</p>
 194
 195 </dd>
 196 <dt id="oext-ext---output-file-extension-ext"><b>-oext</b>=ext, <b>--output-file-extension</b>=ext</dt>
 197 <dd>
 198
 199 <p>Change the extension of the output file to be <i>ext</i> instead of the default <i>tdy</i> (or <i>html</i> in case the -<b>-html</b> option is used). See <a href="#Specifying-File-Extensions">&quot;Specifying File Extensions&quot;</a>.</p>
 200
 201 </dd>
 202 <dt id="opath-path---output-path-path"><b>-opath</b>=path, <b>--output-path</b>=path</dt>
 203 <dd>
 204
 205 <p>When perltidy creates a filename for an output file, by default it merely appends an extension to the path and basename of the input file. This parameter causes the path to be changed to <i>path</i> instead.</p>
 206
 207 <p>The path should end in a valid path separator character, but perltidy will try to add one if it is missing.</p>
 208
 209 <p>For example</p>
 210
 211 <pre><code> perltidy somefile.pl -opath=/tmp/</code></pre>
 212
 213 <p>will produce <i>/tmp/somefile.pl.tdy</i>. Otherwise, <i>somefile.pl.tdy</i> will appear in whatever directory contains <i>somefile.pl</i>.</p>
 214
 215 <p>If the path contains spaces, it should be placed in quotes.</p>
 216
 217 <p>This parameter will be ignored if output is being directed to standard output, or if it is being specified explicitly with the <b>-o=s</b> parameter.</p>
 218
 219 </dd>
 220 <dt id="b---backup-and-modify-in-place"><b>-b</b>, <b>--backup-and-modify-in-place</b></dt>
 221 <dd>
 222
 223 <p>Modify the input file or files in-place and save the original with the extension <i>.bak</i>. Any existing <i>.bak</i> file will be deleted. See next item for changing the default backup extension, and for eliminating the backup file altogether.</p>
 224
 225 <p><b>Please Note</b>: Writing back to the input file increases the risk of data loss or corruption in the event of a software or hardware malfunction. Before using the <b>-b</b> parameter please be sure to have backups and verify that it works correctly in your environment and operating system.</p>
 226
 227 <p>A <b>-b</b> flag will be ignored if input is from standard input or goes to standard output, or if the <b>-html</b> flag is set.</p>
 228
 229 <p>In particular, if you want to use both the <b>-b</b> flag and the <b>-pbp</b> (--perl-best-practices) flag, then you must put a <b>-nst</b> flag after the <b>-pbp</b> flag because it contains a <b>-st</b> flag as one of its components, which means that output will go to the standard output stream.</p>
 230
 231 </dd>
 232 <dt id="bext-ext---backup-file-extension-ext"><b>-bext</b>=ext, <b>--backup-file-extension</b>=ext</dt>
 233 <dd>
 234
 235 <p>This parameter serves two purposes: (1) to change the extension of the backup file to be something other than the default <i>.bak</i>, and (2) to indicate that no backup file should be saved.</p>
 236
 237 <p>To change the default extension to something other than <i>.bak</i> see <a href="#Specifying-File-Extensions">&quot;Specifying File Extensions&quot;</a>.</p>
 238
 239 <p>A backup file of the source is always written, but you can request that it be deleted at the end of processing if there were no errors. This is risky unless the source code is being maintained with a source code control system.</p>
 240
 241 <p>To indicate that the backup should be deleted include one forward slash, <b>/</b>, in the extension. If any text remains after the slash is removed it will be used to define the backup file extension (which is always created and only deleted if there were no errors).</p>
 242
 243 <p>Here are some examples:</p>
 244
 245 <pre><code>  Parameter           Extension          Backup File Treatment
 246   &lt;-bext=bak&gt;         F&lt;.bak&gt;            Keep (same as the default behavior)
 247   &lt;-bext=&#39;/&#39;&gt;         F&lt;.bak&gt;            Delete if no errors
 248   &lt;-bext=&#39;/backup&#39;&gt;   F&lt;.backup&gt;         Delete if no errors
 249   &lt;-bext=&#39;original/&#39;&gt; F&lt;.original&gt;       Delete if no errors</code></pre>
 250
 251 </dd>
 252 <dt id="bm-s---backup-method-s"><b>-bm=s</b>, <b>--backup-method=s</b></dt>
 253 <dd>
 254
 255 <p>This parameter should not normally be used but is available in the event that problems arise as a transition is made from an older implementation of the backup logic to a newer implementation. The newer implementation is the default and is specified with <b>-bm=&#39;copy&#39;</b>. The older implementation is specified with <b>-bm=&#39;move&#39;</b>. The difference is that the older implementation made the backup by moving the input file to the backup file, and the newer implementation makes the backup by copying the input file. The newer implementation preserves the file system <b>inode</b> value. This may avoid problems with other software running simultaneously. This change was made as part of issue <b>git #103</b> at github.</p>
 256
 257 </dd>
 258 <dt id="w---warning-output"><b>-w</b>, <b>--warning-output</b></dt>
 259 <dd>
 260
 261 <p>Setting <b>-w</b> causes any non-critical warning messages to be reported as errors. These include messages about possible pod problems, possibly bad starting indentation level, and cautions about indirect object usage. The default, <b>-nw</b> or <b>--nowarning-output</b>, is not to include these warnings.</p>
 262
 263 </dd>
 264 <dt id="q---quiet"><b>-q</b>, <b>--quiet</b></dt>
 265 <dd>
 266
 267 <p>Deactivate error messages (for running under an editor).</p>
 268
 269 <p>For example, if you use a vi-style editor, such as vim, you may execute perltidy as a filter from within the editor using something like</p>
 270
 271 <pre><code> :n1,n2!perltidy -q</code></pre>
 272
 273 <p>where <code>n1,n2</code> represents the selected text. Without the <b>-q</b> flag, any error message may mess up your screen, so be prepared to use your &quot;undo&quot; key.</p>
 274
 275 </dd>
 276 <dt id="log---logfile"><b>-log</b>, <b>--logfile</b></dt>
 277 <dd>
 278
 279 <p>Save the <i>.LOG</i> file, which has many useful diagnostics. Perltidy always creates a <i>.LOG</i> file, but by default it is deleted unless a program bug is suspected. Setting the <b>-log</b> flag forces the log file to be saved.</p>
 280
 281 </dd>
 282 <dt id="g-n---logfile-gap-n"><b>-g=n</b>, <b>--logfile-gap=n</b></dt>
 283 <dd>
 284
 285 <p>Set maximum interval between input code lines in the logfile. This purpose of this flag is to assist in debugging nesting errors. The value of <code>n</code> is optional. If you set the flag <b>-g</b> without the value of <code>n</code>, it will be taken to be 1, meaning that every line will be written to the log file. This can be helpful if you are looking for a brace, paren, or bracket nesting error.</p>
 286
 287 <p>Setting <b>-g</b> also causes the logfile to be saved, so it is not necessary to also include <b>-log</b>.</p>
 288
 289 <p>If no <b>-g</b> flag is given, a value of 50 will be used, meaning that at least every 50th line will be recorded in the logfile. This helps prevent excessively long log files.</p>
 290
 291 <p>Setting a negative value of <code>n</code> is the same as not setting <b>-g</b> at all.</p>
 292
 293 </dd>
 294 <dt id="npro---noprofile"><b>-npro</b> <b>--noprofile</b></dt>
 295 <dd>
 296
 297 <p>Ignore any <i>.perltidyrc</i> command file. Normally, perltidy looks first in your current directory for a <i>.perltidyrc</i> file of parameters. (The format is described below). If it finds one, it applies those options to the initial default values, and then it applies any that have been defined on the command line. If no <i>.perltidyrc</i> file is found, it looks for one in your home directory.</p>
 298
 299 <p>If you set the <b>-npro</b> flag, perltidy will not look for this file.</p>
 300
 301 </dd>
 302 <dt id="pro-filename-or---profile-filename"><b>-pro=filename</b> or <b>--profile=filename</b></dt>
 303 <dd>
 304
 305 <p>To simplify testing and switching .perltidyrc files, this command may be used to specify a configuration file which will override the default name of .perltidyrc. There must not be a space on either side of the &#39;=&#39; sign. For example, the line</p>
 306
 307 <pre><code>   perltidy -pro=testcfg</code></pre>
 308
 309 <p>would cause file <i>testcfg</i> to be used instead of the default <i>.perltidyrc</i>.</p>
 310
 311 <p>A pathname begins with three dots, e.g. &quot;.../.perltidyrc&quot;, indicates that the file should be searched for starting in the current directory and working upwards. This makes it easier to have multiple projects each with their own .perltidyrc in their root directories.</p>
 312
 313 </dd>
 314 <dt id="opt---show-options"><b>-opt</b>, <b>--show-options</b></dt>
 315 <dd>
 316
 317 <p>Write a list of all options used to the <i>.LOG</i> file. Please see <b>--dump-options</b> for a simpler way to do this.</p>
 318
 319 </dd>
 320 <dt id="f---force-read-binary"><b>-f</b>, <b>--force-read-binary</b></dt>
 321 <dd>
 322
 323 <p>Force perltidy to process binary files. To avoid producing excessive error messages, perltidy skips files identified by the system as non-text. However, valid perl scripts containing binary data may sometimes be identified as non-text, and this flag forces perltidy to process them.</p>
 324
 325 </dd>
 326 <dt id="ast---assert-tidy"><b>-ast</b>, <b>--assert-tidy</b></dt>
 327 <dd>
 328
 329 <p>This flag asserts that the input and output code streams are identical, or in other words that the input code is already &#39;tidy&#39; according to the formatting parameters. If this is not the case, an error message noting this is produced. This error message will cause the process to return a non-zero exit code. The test for this is made by comparing an MD5 hash value for the input and output code streams. This flag has no other effect on the functioning of perltidy. This might be useful for certain code maintenance operations. Note: you will not see this message if you have error messages turned off with the -quiet flag.</p>
 330
 331 </dd>
 332 <dt id="asu---assert-untidy"><b>-asu</b>, <b>--assert-untidy</b></dt>
 333 <dd>
 334
 335 <p>This flag asserts that the input and output code streams are different, or in other words that the input code is &#39;untidy&#39; according to the formatting parameters. If this is not the case, an error message noting this is produced. This flag has no other effect on the functioning of perltidy.</p>
 336
 337 </dd>
 338 </dl>
 339
 340 <h1 id="FORMATTING-OPTIONS">FORMATTING OPTIONS</h1>
 341
 342 <h2 id="Basic-Options">Basic Options</h2>
 343
 344 <dl>
 345
 346 <dt id="notidy"><b>--notidy</b></dt>
 347 <dd>
 348
 349 <p>This flag disables all formatting and causes the input to be copied unchanged to the output except for possible changes in line ending characters and any pre- and post-filters. This can be useful in conjunction with a hierarchical set of <i>.perltidyrc</i> files to avoid unwanted code tidying. See also <a href="#Skipping-Selected-Sections-of-Code">&quot;Skipping Selected Sections of Code&quot;</a> for a way to avoid tidying specific sections of code.</p>
 350
 351 </dd>
 352 <dt id="i-n---indent-columns-n"><b>-i=n</b>, <b>--indent-columns=n</b></dt>
 353 <dd>
 354
 355 <p>Use n columns per indentation level (default n=4).</p>
 356
 357 </dd>
 358 <dt id="l-n---maximum-line-length-n"><b>-l=n</b>, <b>--maximum-line-length=n</b></dt>
 359 <dd>
 360
 361 <p>The default maximum line length is n=80 characters. Perltidy will try to find line break points to keep lines below this length. However, long quotes and side comments may cause lines to exceed this length.</p>
 362
 363 <p>The default length of 80 comes from the past when this was the standard CRT screen width. Many programmers prefer to increase this to something like 120.</p>
 364
 365 <p>Setting <b>-l=0</b> is equivalent to setting <b>-l=(a very large number)</b>. But this is not recommended because, for example, a very long list will be formatted in a single long line.</p>
 366
 367 </dd>
 368 <dt id="vmll---variable-maximum-line-length"><b>-vmll</b>, <b>--variable-maximum-line-length</b></dt>
 369 <dd>
 370
 371 <p>A problem arises using a fixed maximum line length with very deeply nested code and data structures because eventually the amount of leading whitespace used for indicating indentation takes up most or all of the available line width, leaving little or no space for the actual code or data. One solution is to use a very long line length. Another solution is to use the <b>-vmll</b> flag, which basically tells perltidy to ignore leading whitespace when measuring the line length.</p>
 372
 373 <p>To be precise, when the <b>-vmll</b> parameter is set, the maximum line length of a line of code will be M+L*I, where</p>
 374
 375 <pre><code>      M is the value of --maximum-line-length=M (-l=M), default 80,
 376       I is the value of --indent-columns=I (-i=I), default 4,
 377       L is the indentation level of the line of code</code></pre>
 378
 379 <p>When this flag is set, the choice of breakpoints for a block of code should be essentially independent of its nesting depth. However, the absolute line lengths, including leading whitespace, can still be arbitrarily large. This problem can be avoided by including the next parameter.</p>
 380
 381 <p>The default is not to do this (<b>-nvmll</b>).</p>
 382
 383 </dd>
 384 <dt id="wc-n---whitespace-cycle-n"><b>-wc=n</b>, <b>--whitespace-cycle=n</b></dt>
 385 <dd>
 386
 387 <p>This flag also addresses problems with very deeply nested code and data structures. When the nesting depth exceeds the value <b>n</b> the leading whitespace will be reduced and start at a depth of 1 again. The result is that blocks of code will shift back to the left rather than moving arbitrarily far to the right. This occurs cyclically to any depth.</p>
 388
 389 <p>For example if one level of indentation equals 4 spaces (<b>-i=4</b>, the default), and one uses <b>-wc=15</b>, then if the leading whitespace on a line exceeds about 4*15=60 spaces it will be reduced back to 4*1=4 spaces and continue increasing from there. If the whitespace never exceeds this limit the formatting remains unchanged.</p>
 390
 391 <p>The combination of <b>-vmll</b> and <b>-wc=n</b> provides a solution to the problem of displaying arbitrarily deep data structures and code in a finite window, although <b>-wc=n</b> may of course be used without <b>-vmll</b>.</p>
 392
 393 <p>The default is not to use this, which can also be indicated using <b>-wc=0</b>.</p>
 394
 395 </dd>
 396 <dt id="Tabs"><b>Tabs</b></dt>
 397 <dd>
 398
 399 <p>Using tab characters will almost certainly lead to future portability and maintenance problems, so the default and recommendation is not to use them. For those who prefer tabs, however, there are two different options.</p>
 400
 401 <p>Except for possibly introducing tab indentation characters, as outlined below, perltidy does not introduce any tab characters into your file, and it removes any tabs from the code (unless requested not to do so with <b>-fws</b>). If you have any tabs in your comments, quotes, or here-documents, they will remain.</p>
 402
 403 <dl>
 404
 405 <dt id="et-n---entab-leading-whitespace"><b>-et=n</b>, <b>--entab-leading-whitespace</b></dt>
 406 <dd>
 407
 408 <p>This flag causes each <b>n</b> leading space characters produced by the formatting process to be replaced by one tab character. The formatting process itself works with space characters. The <b>-et=n</b> parameter is applied as a last step, after formatting is complete, to convert leading spaces into tabs. Before starting to use tabs, it is essential to first get the indentation controls set as desired without tabs, particularly the two parameters <b>--indent-columns=n</b> (or <b>-i=n</b>) and <b>--continuation-indentation=n</b> (or <b>-ci=n</b>).</p>
 409
 410 <p>The value of the integer <b>n</b> can be any value but can be coordinated with the number of spaces used for indentation. For example, <b>-et=4 -ci=4 -i=4</b> will produce one tab for each indentation level and and one for each continuation indentation level. You may want to coordinate the value of <b>n</b> with what your display software assumes for the spacing of a tab.</p>
 411
 412 </dd>
 413 <dt id="t---tabs"><b>-t</b>, <b>--tabs</b></dt>
 414 <dd>
 415
 416 <p>This flag causes one leading tab character to be inserted for each level of indentation. Certain other features are incompatible with this option, and if these options are also given, then a warning message will be issued and this flag will be unset. One example is the <b>-lp</b> option. This flag is retained for backwards compatibility, but if you use tabs, the <b>-et=n</b> flag is recommended. If both <b>-t</b> and <b>-et=n</b> are set, the <b>-et=n</b> is used.</p>
 417
 418 </dd>
 419 <dt id="dt-n---default-tabsize-n"><b>-dt=n</b>, <b>--default-tabsize=n</b></dt>
 420 <dd>
 421
 422 <p>If the first line of code passed to perltidy contains leading tabs but no tab scheme is specified for the output stream then perltidy must guess how many spaces correspond to each leading tab. This number of spaces <b>n</b> corresponding to each leading tab of the input stream may be specified with <b>-dt=n</b>. The default is <b>n=8</b>.</p>
 423
 424 <p>This flag has no effect if a tab scheme is specified for the output stream, because then the input stream is assumed to use the same tab scheme and indentation spaces as for the output stream (any other assumption would lead to unstable editing).</p>
 425
 426 </dd>
 427 </dl>
 428
 429 </dd>
 430 <dt id="io---indent-only"><b>-io</b>, <b>--indent-only</b></dt>
 431 <dd>
 432
 433 <p>This flag is used to deactivate all whitespace and line break changes within non-blank lines of code. When it is in effect, the only change to the script will be to the indentation and to the number of blank lines. And any flags controlling whitespace and newlines will be ignored. You might want to use this if you are perfectly happy with your whitespace and line breaks, and merely want perltidy to handle the indentation. (This also speeds up perltidy by well over a factor of two, so it might be useful when perltidy is merely being used to help find a brace error in a large script).</p>
 434
 435 <p>Setting this flag is equivalent to setting <b>--freeze-newlines</b> and <b>--freeze-whitespace</b>.</p>
 436
 437 <p>If you also want to keep your existing blank lines exactly as they are, you can add <b>--freeze-blank-lines</b>.</p>
 438
 439 <p>With this option perltidy is still free to modify the indenting (and outdenting) of code and comments as it normally would. If you also want to prevent long comment lines from being outdented, you can add either <b>-noll</b> or <b>-l=0</b>.</p>
 440
 441 <p>Setting this flag will prevent perltidy from doing any special operations on closing side comments. You may still delete all side comments however when this flag is in effect.</p>
 442
 443 </dd>
 444 <dt id="enc-s---character-encoding-s"><b>-enc=s</b>, <b>--character-encoding=s</b></dt>
 445 <dd>
 446
 447 <p>This flag indicates if the input data stream use a character encoding. Perltidy does not look for the encoding directives in the source stream, such as <b>use utf8</b>, and instead relies on this flag to determine the encoding. (Note that perltidy often works on snippets of code rather than complete files so it cannot rely on <b>use utf8</b> directives).</p>
 448
 449 <p>The possible values for <b>s</b> are:</p>
 450
 451 <pre><code> -enc=none if no encoding is used, or
 452  -enc=utf8 for encoding in utf8
 453  -enc=guess if perltidy should guess between these two possibilities.</code></pre>
 454
 455 <p>The value <b>none</b> causes the stream to be processed without special encoding assumptions. This is appropriate for files which are written in single-byte character encodings such as latin-1.</p>
 456
 457 <p>The value <b>utf8</b> causes the stream to be read and written as UTF-8. If the input stream cannot be decoded with this encoding then processing is not done.</p>
 458
 459 <p>The value <b>guess</b> tells perltidy to guess between either utf8 encoding or no encoding (meaning one character per byte). The <b>guess</b> option uses the Encode::Guess module which has been found to be reliable at detecting if a file is encoded in utf8 or not.</p>
 460
 461 <p>The current default is <b>guess</b>.</p>
 462
 463 <p>The abbreviations <b>-utf8</b> or <b>-UTF8</b> are equivalent to <b>-enc=utf8</b>, and the abbreviation <b>-guess</b> is equivalent to <b>-enc=guess</b>. So to process a file named <b>file.pl</b> which is encoded in UTF-8 you can use:</p>
 464
 465 <pre><code>   perltidy -utf8 file.pl</code></pre>
 466
 467 <p>or</p>
 468
 469 <pre><code>   perltidy -guess file.pl</code></pre>
 470
 471 <p>or simply</p>
 472
 473 <pre><code>   perltidy file.pl</code></pre>
 474
 475 <p>since <b>-guess</b> is the default.</p>
 476
 477 <p>To process files with an encoding other than UTF-8, it would be necessary to write a short program which calls the Perl::Tidy module with some pre- and post-processing to handle decoding and encoding.</p>
 478
 479 </dd>
 480 <dt id="eos-s---encode-output-strings-s"><b>-eos=s</b>, <b>--encode-output-strings=s</b></dt>
 481 <dd>
 482
 483 <p>This flag was added to resolve an issue involving the interface between Perl::Tidy and calling programs, and in particular <b>Code::TidyAll (tidyall)</b>.</p>
 484
 485 <p>If you only run the <b>perltidy</b> binary this flag has no effect. If you run a program which calls the Perl::Tidy module and receives a string in return, then the meaning of the flag is as follows:</p>
 486
 487 <ul>
 488
 489 <li><p>The setting <b>-eos</b> means Perl::Tidy should encode any string which it decodes. This is the default because it makes perltidy behave well as a filter, and is the correct setting for most programs.</p>
 490
 491 </li>
 492 <li><p>The setting <b>-neos</b> means that a string should remain decoded if it was decoded by Perl::Tidy. This is only appropriate if the calling program will handle any needed encoding before outputting the string.</p>
 493
 494 </li>
 495 </ul>
 496
 497 <p>The default was changed from <b>-neos</b> to <b>-eos</b> in versions after 20220217. If this change causes a program to start running incorrectly on encoded files, an emergency fix might be to set <b>-neos</b>. Additional information can be found in the man pages for the <b>Perl::Tidy</b> module and also in <a href="https://github.com/perltidy/perltidy/blob/master/docs/eos_flag.md">https://github.com/perltidy/perltidy/blob/master/docs/eos_flag.md</a>.</p>
 498
 499 </dd>
 500 <dt id="gcs---use-unicode-gcstring"><b>-gcs</b>, <b>--use-unicode-gcstring</b></dt>
 501 <dd>
 502
 503 <p>This flag controls whether or not perltidy may use module Unicode::GCString to obtain accurate display widths of wide characters. The default is <b>--nouse-unicode-gcstring</b>.</p>
 504
 505 <p>If this flag is set, and text is encoded, perltidy will look for the module Unicode::GCString and, if found, will use it to obtain character display widths. This can improve displayed vertical alignment for files with wide characters. It is a nice feature but it is off by default to avoid conflicting formatting when there are multiple developers. Perltidy installation does not require Unicode::GCString, so users wanting to use this feature need set this flag and also to install Unicode::GCString separately.</p>
 506
 507 <p>If this flag is set and perltidy does not find module Unicode::GCString, a warning message will be produced and processing will continue but without the potential benefit provided by the module.</p>
 508
 509 <p>Also note that actual vertical alignment depends upon the fonts used by the text display software, so vertical alignment may not be optimal even when Unicode::GCString is used.</p>
 510
 511 </dd>
 512 <dt id="ole-s---output-line-ending-s"><b>-ole=s</b>, <b>--output-line-ending=s</b></dt>
 513 <dd>
 514
 515 <p>where s=<code>win</code>, <code>dos</code>, <code>unix</code>, or <code>mac</code>. This flag tells perltidy to output line endings for a specific system. Normally, perltidy writes files with the line separator character of the host system. The <code>win</code> and <code>dos</code> flags have an identical result.</p>
 516
 517 </dd>
 518 <dt id="ple---preserve-line-endings"><b>-ple</b>, <b>--preserve-line-endings</b></dt>
 519 <dd>
 520
 521 <p>This flag tells perltidy to write its output files with the same line endings as the input file, if possible. It should work for <b>dos</b>, <b>unix</b>, and <b>mac</b> line endings. It will only work if perltidy input comes from a filename (rather than stdin, for example). If perltidy has trouble determining the input file line ending, it will revert to the default behavior of using the line ending of the host system.</p>
 522
 523 </dd>
 524 <dt id="atnl---add-terminal-newline"><b>-atnl</b>, <b>--add-terminal-newline</b></dt>
 525 <dd>
 526
 527 <p>This flag, which is enabled by default, allows perltidy to terminate the last line of the output stream with a newline character, regardless of whether or not the input stream was terminated with a newline character. If this flag is negated, with <b>-natnl</b>, then perltidy will add a terminal newline to the the output stream only if the input stream is terminated with a newline.</p>
 528
 529 <p>Negating this flag may be useful for manipulating one-line scripts intended for use on a command line.</p>
 530
 531 </dd>
 532 <dt id="it-n---iterations-n"><b>-it=n</b>, <b>--iterations=n</b></dt>
 533 <dd>
 534
 535 <p>This flag causes perltidy to do <b>n</b> complete iterations. The reason for this flag is that code beautification is an iterative process and in some cases the output from perltidy can be different if it is applied a second time. For most purposes the default of <b>n=1</b> should be satisfactory. However <b>n=2</b> can be useful when a major style change is being made, or when code is being beautified on check-in to a source code control system. It has been found to be extremely rare for the output to change after 2 iterations. If a value <b>n</b> is greater than 2 is input then a convergence test will be used to stop the iterations as soon as possible, almost always after 2 iterations. See the next item for a simplified iteration control.</p>
 536
 537 <p>This flag has no effect when perltidy is used to generate html.</p>
 538
 539 </dd>
 540 <dt id="conv---converge"><b>-conv</b>, <b>--converge</b></dt>
 541 <dd>
 542
 543 <p>This flag is equivalent to <b>-it=4</b> and is included to simplify iteration control. For all practical purposes one either does or does not want to be sure that the output is converged, and there is no penalty to using a large iteration limit since perltidy will check for convergence and stop iterating as soon as possible. The default is <b>-nconv</b> (no convergence check). Using <b>-conv</b> will approximately double run time since typically one extra iteration is required to verify convergence. No extra iterations are required if no new line breaks are made, and two extra iterations are occasionally needed when reformatting complex code structures, such as deeply nested ternary statements.</p>
 544
 545 </dd>
 546 </dl>
 547
 548 <h2 id="Code-Indentation-Control">Code Indentation Control</h2>
 549
 550 <dl>
 551
 552 <dt id="ci-n---continuation-indentation-n"><b>-ci=n</b>, <b>--continuation-indentation=n</b></dt>
 553 <dd>
 554
 555 <p>Continuation indentation is extra indentation spaces applied when a long line is broken. The default is n=2, illustrated here:</p>
 556
 557 <pre><code> my $level =   # -ci=2
 558    ( $max_index_to_go &gt;= 0 ) ? $levels_to_go[0] : $last_output_level;</code></pre>
 559
 560 <p>The same example, with n=0, is a little harder to read:</p>
 561
 562 <pre><code> my $level =   # -ci=0
 563  ( $max_index_to_go &gt;= 0 ) ? $levels_to_go[0] : $last_output_level;</code></pre>
 564
 565 <p>The value given to <b>-ci</b> is also used by some commands when a small space is required. Examples are commands for outdenting labels, <b>-ola</b>, and control keywords, <b>-okw</b>.</p>
 566
 567 <p>When default values are not used, it is recommended that either</p>
 568
 569 <p>(1) the value <b>n</b> given with <b>-ci=n</b> be no more than about one-half of the number of spaces assigned to a full indentation level on the <b>-i=n</b> command, or</p>
 570
 571 <p>(2) the flag <b>-extended-continuation-indentation</b> is used (see next section).</p>
 572
 573 </dd>
 574 <dt id="xci---extended-continuation-indentation"><b>-xci</b>, <b>--extended-continuation-indentation</b></dt>
 575 <dd>
 576
 577 <p>This flag allows perltidy to use some improvements which have been made to its indentation model. One of the things it does is &quot;extend&quot; continuation indentation deeper into structures, hence the name. The improved indentation is particularly noticeable when the flags <b>-ci=n</b> and <b>-i=n</b> use the same value of <b>n</b>. There are no significant disadvantages to using this flag, but to avoid disturbing existing formatting the default is not to use it, <b>-nxci</b>.</p>
 578
 579 <p>Please see the section <a href="#pbp---perl-best-practices">&quot;<b>-pbp</b>, <b>--perl-best-practices</b>&quot;</a> for an example of how this flag can improve the formatting of ternary statements. It can also improve indentation of some multi-line qw lists as shown below.</p>
 580
 581 <pre><code>            # perltidy
 582             foreach $color (
 583                 qw(
 584                 AntiqueWhite3 Bisque1 Bisque2 Bisque3 Bisque4
 585                 SlateBlue3 RoyalBlue1 SteelBlue2 DeepSkyBlue3
 586                 ),
 587                 qw(
 588                 LightBlue1 DarkSlateGray1 Aquamarine2 DarkSeaGreen2
 589                 SeaGreen1 Yellow1 IndianRed1 IndianRed2 Tan1 Tan4
 590                 )
 591               )
 592
 593             # perltidy -xci
 594             foreach $color (
 595                 qw(
 596                     AntiqueWhite3 Bisque1 Bisque2 Bisque3 Bisque4
 597                     SlateBlue3 RoyalBlue1 SteelBlue2 DeepSkyBlue3
 598                 ),
 599                 qw(
 600                     LightBlue1 DarkSlateGray1 Aquamarine2 DarkSeaGreen2
 601                     SeaGreen1 Yellow1 IndianRed1 IndianRed2 Tan1 Tan4
 602                 )
 603               )</code></pre>
 604
 605 </dd>
 606 <dt id="sil-n---starting-indentation-level-n"><b>-sil=n</b> <b>--starting-indentation-level=n</b></dt>
 607 <dd>
 608
 609 <p>By default, perltidy examines the input file and tries to determine the starting indentation level. While it is often zero, it may not be zero for a code snippet being sent from an editing session.</p>
 610
 611 <p>To guess the starting indentation level perltidy simply assumes that indentation scheme used to create the code snippet is the same as is being used for the current perltidy process. This is the only sensible guess that can be made. It should be correct if this is true, but otherwise it probably won&#39;t. For example, if the input script was written with -i=2 and the current perltidy flags have -i=4, the wrong initial indentation will be guessed for a code snippet which has non-zero initial indentation. Likewise, if an entabbing scheme is used in the input script and not in the current process then the guessed indentation will be wrong.</p>
 612
 613 <p>If the default method does not work correctly, or you want to change the starting level, use <b>-sil=n</b>, to force the starting level to be n.</p>
 614
 615 </dd>
 616 <dt id="List-indentation-using---line-up-parentheses--lp-or---extended--line-up-parentheses--xlp"><b>List indentation</b> using <b>--line-up-parentheses</b>, <b>-lp</b> or <b>--extended--line-up-parentheses</b> , <b>-xlp</b></dt>
 617 <dd>
 618
 619 <p>These flags provide an alternative indentation method for list data. The original flag for this is <b>-lp</b>, but it has some limitations (explained below) which are avoided with the newer <b>-xlp</b> flag. So <b>-xlp</b> is probably the better choice for new work, but the <b>-lp</b> flag is retained to minimize changes to existing formatting. If you enter both <b>-lp</b> and <b>-xlp</b>, then <b>-xlp</b> will be used.</p>
 620
 621 <p>In the default indentation method perltidy indents lists with 4 spaces, or whatever value is specified with <b>-i=n</b>. Here is a small list formatted in this way:</p>
 622
 623 <pre><code>    # perltidy (default)
 624     @month_of_year = (
 625         &#39;Jan&#39;, &#39;Feb&#39;, &#39;Mar&#39;, &#39;Apr&#39;, &#39;May&#39;, &#39;Jun&#39;,
 626         &#39;Jul&#39;, &#39;Aug&#39;, &#39;Sep&#39;, &#39;Oct&#39;, &#39;Nov&#39;, &#39;Dec&#39;
 627     );</code></pre>
 628
 629 <p>The <b>-lp</b> or <b>-xlp</b> flags add extra indentation to cause the data to begin past the opening parentheses of a sub call or list, or opening square bracket of an anonymous array, or opening curly brace of an anonymous hash. With this option, the above list would become:</p>
 630
 631 <pre><code>    # perltidy -lp or -xlp
 632     @month_of_year = (
 633                        &#39;Jan&#39;, &#39;Feb&#39;, &#39;Mar&#39;, &#39;Apr&#39;, &#39;May&#39;, &#39;Jun&#39;,
 634                        &#39;Jul&#39;, &#39;Aug&#39;, &#39;Sep&#39;, &#39;Oct&#39;, &#39;Nov&#39;, &#39;Dec&#39;
 635     );</code></pre>
 636
 637 <p>If the available line length (see <b>-l=n</b> ) does not permit this much space, perltidy will use less. For alternate placement of the closing paren, see the next section.</p>
 638
 639 <p>These flags have no effect on code BLOCKS, such as if/then/else blocks, which always use whatever is specified with <b>-i=n</b>.</p>
 640
 641 <p>Some limitations on these flags are:</p>
 642
 643 <ul>
 644
 645 <li><p>A limitation on <b>-lp</b>, but not <b>-xlp</b>, occurs in situations where perltidy does not have complete freedom to choose line breaks. Then it may temporarily revert to its default indentation method. This can occur for example if there are blank lines, block comments, multi-line quotes, or side comments between the opening and closing parens, braces, or brackets. It will also occur if a multi-line anonymous sub occurs within a container since that will impose specific line breaks (such as line breaks after statements).</p>
 646
 647 </li>
 648 <li><p>For both the <b>-lp</b> and <b>-xlp</b> flags, any parameter which significantly restricts the ability of perltidy to choose newlines will conflict with these flags and will cause them to be deactivated. These include <b>-io</b>, <b>-fnl</b>, <b>-nanl</b>, and <b>-ndnl</b>.</p>
 649
 650 </li>
 651 <li><p>The <b>-lp</b> and <b>-xlp</b> options may not be used together with the <b>-t</b> tabs option. They may, however, be used with the <b>-et=n</b> tab method</p>
 652
 653 </li>
 654 </ul>
 655
 656 <p>There are some potential disadvantages of this indentation method compared to the default method that should be noted:</p>
 657
 658 <ul>
 659
 660 <li><p>The available line length can quickly be used up if variable names are long. This can cause deeply nested code to quickly reach the line length limit, and become badly formatted, much sooner than would occur with the default indentation method.</p>
 661
 662 </li>
 663 <li><p>Since the indentation depends on the lengths of variable names, small changes in variable names can cause changes in indentation over many lines in a file. This means that minor name changes can produce significant file differences. This can be annoying and does not occur with the default indentation method.</p>
 664
 665 </li>
 666 </ul>
 667
 668 <p>Some things that can be done to minimize these problems are:</p>
 669
 670 <ul>
 671
 672 <li><p>Increase <b>--maximum-line-length=n</b> above the default <b>n=80</b> characters if necessary.</p>
 673
 674 </li>
 675 <li><p>If you use <b>-xlp</b> then long side comments can limit the indentation over multiple lines. Consider adding the flag <b>--ignore-side-comment-lengths</b> to prevent this, or minimizing the use of side comments.</p>
 676
 677 </li>
 678 <li><p>Apply this style in a limited way. By default, it applies to all list containers (not just lists in parentheses). The next section describes how to limit this style to, for example, just function calls. The default indentation method will be applied elsewhere.</p>
 679
 680 </li>
 681 </ul>
 682
 683 </dd>
 684 <dt id="lpil-s---line-up-parentheses-inclusion-list-and--lpxl-s---line-up-parentheses-exclusion-list"><b>-lpil=s</b>, <b>--line-up-parentheses-inclusion-list</b> and <b>-lpxl=s</b>, <b>--line-up-parentheses-exclusion-list</b></dt>
 685 <dd>
 686
 687 <p>The following discussion is written for <b>-lp</b> but applies equally to the newer <b>-xlp</b> version. By default, the <b>-lp</b> flag applies to as many containers as possible. The set of containers to which the <b>-lp</b> style applies can be reduced by either one of these two flags:</p>
 688
 689 <p>Use <b>-lpil=s</b> to specify the containers to which <b>-lp</b> applies, or</p>
 690
 691 <p>use <b>-lpxl=s</b> to specify the containers to which <b>-lp</b> does NOT apply.</p>
 692
 693 <p>Only one of these two flags may be used. Both flags can achieve the same result, but the <b>-lpil=s</b> flag is much easier to describe and use and is recommended. The <b>-lpxl=s</b> flag was the original implementation and is only retained for backwards compatibility.</p>
 694
 695 <p>This list <b>s</b> for these parameters is a string with space-separated items. Each item consists of up to three pieces of information in this order: (1) an optional letter code (2) a required container type, and (3) an optional numeric code.</p>
 696
 697 <p>The only required piece of information is a container type, which is one of &#39;(&#39;, &#39;[&#39;, or &#39;{&#39;. For example the string</p>
 698
 699 <pre><code>  -lpil=&#39;(&#39;</code></pre>
 700
 701 <p>means use -lp formatting only on lists within parentheses, not lists in square-brackets or braces. The same thing could alternatively be specified with</p>
 702
 703 <pre><code>  -lpxl = &#39;[ {&#39;</code></pre>
 704
 705 <p>which says to exclude lists within square-brackets and braces. So what remains is lists within parentheses.</p>
 706
 707 <p>A second optional item of information which can be given for parentheses is an alphanumeric letter which is used to limit the selection further depending on the type of token immediately before the paren. The possible letters are currently &#39;k&#39;, &#39;K&#39;, &#39;f&#39;, &#39;F&#39;, &#39;w&#39;, and &#39;W&#39;, with these meanings for matching whatever precedes an opening paren:</p>
 708
 709 <pre><code> &#39;k&#39; matches if the previous nonblank token is a perl built-in keyword (such as &#39;if&#39;, &#39;while&#39;),
 710  &#39;K&#39; matches if &#39;k&#39; does not, meaning that the previous token is not a keyword.
 711  &#39;f&#39; matches if the previous token is a function other than a keyword.
 712  &#39;F&#39; matches if &#39;f&#39; does not.
 713  &#39;w&#39; matches if either &#39;k&#39; or &#39;f&#39; match.
 714  &#39;W&#39; matches if &#39;w&#39; does not.</code></pre>
 715
 716 <p>For example:</p>
 717
 718 <pre><code>  -lpil = &#39;f(&#39;</code></pre>
 719
 720 <p>means only apply -lp to function calls, and</p>
 721
 722 <pre><code>  -lpil = &#39;w(&#39;</code></pre>
 723
 724 <p>means only apply -lp to parenthesized lists which follow a function or a keyword.</p>
 725
 726 <p>This last example could alternatively be written using the <b>-lpxl=s</b> flag as</p>
 727
 728 <pre><code>  -lpxl = &#39;[ { W(&#39;</code></pre>
 729
 730 <p>which says exclude <b>-lp</b> for lists within square-brackets, braces, and parens NOT preceded by a keyword or function. Clearly, the <b>-lpil=s</b> method is easier to understand.</p>
 731
 732 <p>An optional numeric code may follow any of the container types to further refine the selection based on container contents. The numeric codes are:</p>
 733
 734 <pre><code>  &#39;0&#39; or blank: no check on contents is made
 735   &#39;1&#39; exclude B&lt;-lp&gt; unless the contents is a simple list without sublists
 736   &#39;2&#39; exclude B&lt;-lp&gt; unless the contents is a simple list without sublists, without
 737       code blocks, and without ternary operators</code></pre>
 738
 739 <p>For example,</p>
 740
 741 <pre><code>  -lpil = &#39;f(2&#39;</code></pre>
 742
 743 <p>means only apply -lp to function call lists which do not contain any sublists, code blocks or ternary expressions.</p>
 744
 745 </dd>
 746 <dt id="cti-n---closing-token-indentation"><b>-cti=n</b>, <b>--closing-token-indentation</b></dt>
 747 <dd>
 748
 749 <p>The <b>-cti=n</b> flag controls the indentation of a line beginning with a <code>)</code>, <code>]</code>, or a non-block <code>}</code>. Such a line receives:</p>
 750
 751 <pre><code> -cti = 0 no extra indentation (default)
 752  -cti = 1 extra indentation such that the closing token
 753         aligns with its opening token.
 754  -cti = 2 one extra indentation level if the line looks like:
 755         );  or  ];  or  };
 756  -cti = 3 one extra indentation level always</code></pre>
 757
 758 <p>The flags <b>-cti=1</b> and <b>-cti=2</b> work well with the <b>-lp</b> flag (previous section).</p>
 759
 760 <pre><code>    # perltidy -lp -cti=1
 761     @month_of_year = (
 762                        &#39;Jan&#39;, &#39;Feb&#39;, &#39;Mar&#39;, &#39;Apr&#39;, &#39;May&#39;, &#39;Jun&#39;,
 763                        &#39;Jul&#39;, &#39;Aug&#39;, &#39;Sep&#39;, &#39;Oct&#39;, &#39;Nov&#39;, &#39;Dec&#39;
 764                      );
 765
 766     # perltidy -lp -cti=2
 767     @month_of_year = (
 768                        &#39;Jan&#39;, &#39;Feb&#39;, &#39;Mar&#39;, &#39;Apr&#39;, &#39;May&#39;, &#39;Jun&#39;,
 769                        &#39;Jul&#39;, &#39;Aug&#39;, &#39;Sep&#39;, &#39;Oct&#39;, &#39;Nov&#39;, &#39;Dec&#39;
 770                        );</code></pre>
 771
 772 <p>These flags are merely hints to the formatter and they may not always be followed. In particular, if -lp is not being used, the indentation for <b>cti=1</b> is constrained to be no more than one indentation level.</p>
 773
 774 <p>If desired, this control can be applied independently to each of the closing container token types. In fact, <b>-cti=n</b> is merely an abbreviation for <b>-cpi=n -csbi=n -cbi=n</b>, where: <b>-cpi</b> or <b>--closing-paren-indentation</b> controls <b>)</b>&#39;s, <b>-csbi</b> or <b>--closing-square-bracket-indentation</b> controls <b>]</b>&#39;s, <b>-cbi</b> or <b>--closing-brace-indentation</b> controls non-block <b>}</b>&#39;s.</p>
 775
 776 </dd>
 777 <dt id="icp---indent-closing-paren"><b>-icp</b>, <b>--indent-closing-paren</b></dt>
 778 <dd>
 779
 780 <p>The <b>-icp</b> flag is equivalent to <b>-cti=2</b>, described in the previous section. The <b>-nicp</b> flag is equivalent <b>-cti=0</b>. They are included for backwards compatibility.</p>
 781
 782 </dd>
 783 <dt id="icb---indent-closing-brace"><b>-icb</b>, <b>--indent-closing-brace</b></dt>
 784 <dd>
 785
 786 <p>The <b>-icb</b> option gives one extra level of indentation to a brace which terminates a code block . For example,</p>
 787
 788 <pre><code>        if ($task) {
 789             yyy();
 790             }    # -icb
 791         else {
 792             zzz();
 793             }</code></pre>
 794
 795 <p>The default is not to do this, indicated by <b>-nicb</b>.</p>
 796
 797 </dd>
 798 <dt id="nib---non-indenting-braces"><b>-nib</b>, <b>--non-indenting-braces</b></dt>
 799 <dd>
 800
 801 <p>Normally, lines of code contained within a pair of block braces receive one additional level of indentation. This flag, which is enabled by default, causes perltidy to look for opening block braces which are followed by a special side comment. This special side comment is <b>#&lt;&lt;&lt;</b> by default. If found, the code between this opening brace and its corresponding closing brace will not be given the normal extra indentation level. For example:</p>
 802
 803 <pre><code>            { #&lt;&lt;&lt;   a closure to contain lexical vars
 804
 805             my $var;  # this line does not get one level of indentation
 806             ...
 807
 808             }
 809
 810             # this line does not &#39;see&#39; $var;</code></pre>
 811
 812 <p>This can be useful, for example, when combining code from different files. Different sections of code can be placed within braces to keep their lexical variables from being visible to the end of the file. To keep the new braces from causing all of their contained code to be indented if you run perltidy, and possibly introducing new line breaks in long lines, you can mark the opening braces with this special side comment.</p>
 813
 814 <p>Only the opening brace needs to be marked, since perltidy knows where the closing brace is. Braces contained within marked braces may also be marked as non-indenting.</p>
 815
 816 <p>If your code happens to have some opening braces followed by &#39;#&lt;&lt;&lt;&#39;, and you don&#39;t want this behavior, you can use <b>-nnib</b> to deactivate it. To make it easy to remember, the default string is the same as the string for starting a <b>format-skipping</b> section. There is no confusion because in that case it is for a block comment rather than a side-comment.</p>
 817
 818 <p>The special side comment can be changed with the next parameter.</p>
 819
 820 </dd>
 821 <dt id="nibp-s---non-indenting-brace-prefix-s"><b>-nibp=s</b>, <b>--non-indenting-brace-prefix=s</b></dt>
 822 <dd>
 823
 824 <p>The <b>-nibp=string</b> parameter may be used to change the marker for non-indenting braces. The default is equivalent to -nibp=&#39;#&lt;&lt;&lt;&#39;. The string that you enter must begin with a # and should be in quotes as necessary to get past the command shell of your system. This string is the leading text of a regex pattern that is constructed by appending pre-pending a &#39;^&#39; and appending a&#39;\s&#39;, so you must also include backslashes for characters to be taken literally rather than as patterns.</p>
 825
 826 <p>For example, to match the side comment &#39;#++&#39;, the parameter would be</p>
 827
 828 <pre><code>  -nibp=&#39;#\+\+&#39;</code></pre>
 829
 830 </dd>
 831 <dt id="olq---outdent-long-quotes"><b>-olq</b>, <b>--outdent-long-quotes</b></dt>
 832 <dd>
 833
 834 <p>When <b>-olq</b> is set, lines which is a quoted string longer than the value <b>maximum-line-length</b> will have their indentation removed to make them more readable. This is the default. To prevent such out-denting, use <b>-nolq</b> or <b>--nooutdent-long-lines</b>.</p>
 835
 836 </dd>
 837 <dt id="oll---outdent-long-lines"><b>-oll</b>, <b>--outdent-long-lines</b></dt>
 838 <dd>
 839
 840 <p>This command is equivalent to <b>--outdent-long-quotes</b> and <b>--outdent-long-comments</b>, and it is included for compatibility with previous versions of perltidy. The negation of this also works, <b>-noll</b> or <b>--nooutdent-long-lines</b>, and is equivalent to setting <b>-nolq</b> and <b>-nolc</b>.</p>
 841
 842 </dd>
 843 <dt id="Outdenting-Labels:--ola---outdent-labels"><b>Outdenting Labels:</b> <b>-ola</b>, <b>--outdent-labels</b></dt>
 844 <dd>
 845
 846 <p>This command will cause labels to be outdented by 2 spaces (or whatever <b>-ci</b> has been set to), if possible. This is the default. For example:</p>
 847
 848 <pre><code>        my $i;
 849       LOOP: while ( $i = &lt;FOTOS&gt; ) {
 850             chomp($i);
 851             next unless $i;
 852             fixit($i);
 853         }</code></pre>
 854
 855 <p>Use <b>-nola</b> to not outdent labels. To control line breaks after labels see <a href="#bal-n---break-after-labels-n">&quot;-bal=n, --break-after-labels=n&quot;</a>.</p>
 856
 857 </dd>
 858 <dt id="Outdenting-Keywords"><b>Outdenting Keywords</b></dt>
 859 <dd>
 860
 861 <dl>
 862
 863 <dt id="okw---outdent-keywords"><b>-okw</b>, <b>--outdent-keywords</b></dt>
 864 <dd>
 865
 866 <p>The command <b>-okw</b> will cause certain leading control keywords to be outdented by 2 spaces (or whatever <b>-ci</b> has been set to), if possible. By default, these keywords are <code>redo</code>, <code>next</code>, <code>last</code>, <code>goto</code>, and <code>return</code>. The intention is to make these control keywords easier to see. To change this list of keywords being outdented, see the next section.</p>
 867
 868 <p>For example, using <code>perltidy -okw</code> on the previous example gives:</p>
 869
 870 <pre><code>        my $i;
 871       LOOP: while ( $i = &lt;FOTOS&gt; ) {
 872             chomp($i);
 873           next unless $i;
 874             fixit($i);
 875         }</code></pre>
 876
 877 <p>The default is not to do this.</p>
 878
 879 </dd>
 880 <dt id="Specifying-Outdented-Keywords:--okwl-string---outdent-keyword-list-string"><b>Specifying Outdented Keywords:</b> <b>-okwl=string</b>, <b>--outdent-keyword-list=string</b></dt>
 881 <dd>
 882
 883 <p>This command can be used to change the keywords which are outdented with the <b>-okw</b> command. The parameter <b>string</b> is a required list of perl keywords, which should be placed in quotes if there are more than one. By itself, it does not cause any outdenting to occur, so the <b>-okw</b> command is still required.</p>
 884
 885 <p>For example, the commands <code>-okwl=&quot;next last redo goto&quot; -okw</code> will cause those four keywords to be outdented. It is probably simplest to place any <b>-okwl</b> command in a <i>.perltidyrc</i> file.</p>
 886
 887 </dd>
 888 </dl>
 889
 890 </dd>
 891 </dl>
 892
 893 <h2 id="Whitespace-Control">Whitespace Control</h2>
 894
 895 <p>Whitespace refers to the blank space between variables, operators, and other code tokens.</p>
 896
 897 <dl>
 898
 899 <dt id="fws---freeze-whitespace"><b>-fws</b>, <b>--freeze-whitespace</b></dt>
 900 <dd>
 901
 902 <p>This flag causes your original whitespace to remain unchanged, and causes the rest of the whitespace commands in this section, the Code Indentation section, and the Comment Control section to be ignored.</p>
 903
 904 </dd>
 905 <dt id="Tightness-of-curly-braces-parentheses-and-square-brackets"><b>Tightness of curly braces, parentheses, and square brackets</b></dt>
 906 <dd>
 907
 908 <p>Here the term &quot;tightness&quot; will mean the closeness with which pairs of enclosing tokens, such as parentheses, contain the quantities within. A numerical value of 0, 1, or 2 defines the tightness, with 0 being least tight and 2 being most tight. Spaces within containers are always symmetric, so if there is a space after a <code>(</code> then there will be a space before the corresponding <code>)</code>.</p>
 909
 910 <p>The <b>-pt=n</b> or <b>--paren-tightness=n</b> parameter controls the space within parens. The example below shows the effect of the three possible values, 0, 1, and 2:</p>
 911
 912 <pre><code> if ( ( my $len_tab = length( $tabstr ) ) &gt; 0 ) {  # -pt=0
 913  if ( ( my $len_tab = length($tabstr) ) &gt; 0 ) {    # -pt=1 (default)
 914  if ((my $len_tab = length($tabstr)) &gt; 0) {        # -pt=2</code></pre>
 915
 916 <p>When n is 0, there is always a space to the right of a &#39;(&#39; and to the left of a &#39;)&#39;. For n=2 there is never a space. For n=1, the default, there is a space unless the quantity within the parens is a single token, such as an identifier or quoted string.</p>
 917
 918 <p>Likewise, the parameter <b>-sbt=n</b> or <b>--square-bracket-tightness=n</b> controls the space within square brackets, as illustrated below.</p>
 919
 920 <pre><code> $width = $col[ $j + $k ] - $col[ $j ];  # -sbt=0
 921  $width = $col[ $j + $k ] - $col[$j];    # -sbt=1 (default)
 922  $width = $col[$j + $k] - $col[$j];      # -sbt=2</code></pre>
 923
 924 <p>Curly braces which do not contain code blocks are controlled by the parameter <b>-bt=n</b> or <b>--brace-tightness=n</b>.</p>
 925
 926 <pre><code> $obj-&gt;{ $parsed_sql-&gt;{ &#39;table&#39; }[0] };    # -bt=0
 927  $obj-&gt;{ $parsed_sql-&gt;{&#39;table&#39;}[0] };      # -bt=1 (default)
 928  $obj-&gt;{$parsed_sql-&gt;{&#39;table&#39;}[0]};        # -bt=2</code></pre>
 929
 930 <p>And finally, curly braces which contain blocks of code are controlled by the parameter <b>-bbt=n</b> or <b>--block-brace-tightness=n</b> as illustrated in the example below.</p>
 931
 932 <pre><code> %bf = map { $_ =&gt; -M $_ } grep { /\.deb$/ } dirents &#39;.&#39;; # -bbt=0 (default)
 933  %bf = map { $_ =&gt; -M $_ } grep {/\.deb$/} dirents &#39;.&#39;;   # -bbt=1
 934  %bf = map {$_ =&gt; -M $_} grep {/\.deb$/} dirents &#39;.&#39;;     # -bbt=2</code></pre>
 935
 936 <p>To simplify input in the case that all of the tightness flags have the same value &lt;n&gt;, the parameter &lt;-act=n&gt; or <b>--all-containers-tightness=n</b> is an abbreviation for the combination &lt;-pt=n -sbt=n -bt=n -bbt=n&gt;.</p>
 937
 938 </dd>
 939 <dt id="tso---tight-secret-operators"><b>-tso</b>, <b>--tight-secret-operators</b></dt>
 940 <dd>
 941
 942 <p>The flag <b>-tso</b> causes certain perl token sequences (secret operators) which might be considered to be a single operator to be formatted &quot;tightly&quot; (without spaces). The operators currently modified by this flag are:</p>
 943
 944 <pre><code>     0+  +0  ()x!! ~~&lt;&gt;  ,=&gt;   =( )=</code></pre>
 945
 946 <p>For example the sequence <b>0 +</b>, which converts a string to a number, would be formatted without a space: <b>0+</b> when the <b>-tso</b> flag is set. This flag is off by default.</p>
 947
 948 </dd>
 949 <dt id="sts---space-terminal-semicolon"><b>-sts</b>, <b>--space-terminal-semicolon</b></dt>
 950 <dd>
 951
 952 <p>Some programmers prefer a space before all terminal semicolons. The default is for no such space, and is indicated with <b>-nsts</b> or <b>--nospace-terminal-semicolon</b>.</p>
 953
 954 <pre><code>        $i = 1 ;     #  -sts
 955         $i = 1;      #  -nsts   (default)</code></pre>
 956
 957 </dd>
 958 <dt id="sfs---space-for-semicolon"><b>-sfs</b>, <b>--space-for-semicolon</b></dt>
 959 <dd>
 960
 961 <p>Semicolons within <b>for</b> loops may sometimes be hard to see, particularly when commas are also present. This option places spaces on both sides of these special semicolons, and is the default. Use <b>-nsfs</b> or <b>--nospace-for-semicolon</b> to deactivate it.</p>
 962
 963 <pre><code> for ( @a = @$ap, $u = shift @a ; @a ; $u = $v ) {  # -sfs (default)
 964  for ( @a = @$ap, $u = shift @a; @a; $u = $v ) {    # -nsfs</code></pre>
 965
 966 </dd>
 967 <dt id="asc---add-semicolons"><b>-asc</b>, <b>--add-semicolons</b></dt>
 968 <dd>
 969
 970 <p>Setting <b>-asc</b> allows perltidy to add any missing optional semicolon at the end of a line which is followed by a closing curly brace on the next line. This is the default, and may be deactivated with <b>-nasc</b> or <b>--noadd-semicolons</b>.</p>
 971
 972 </dd>
 973 <dt id="dsm---delete-semicolons"><b>-dsm</b>, <b>--delete-semicolons</b></dt>
 974 <dd>
 975
 976 <p>Setting <b>-dsm</b> allows perltidy to delete extra semicolons which are simply empty statements. This is the default, and may be deactivated with <b>-ndsm</b> or <b>--nodelete-semicolons</b>. (Such semicolons are not deleted, however, if they would promote a side comment to a block comment).</p>
 977
 978 </dd>
 979 <dt id="aws---add-whitespace"><b>-aws</b>, <b>--add-whitespace</b></dt>
 980 <dd>
 981
 982 <p>Setting this option allows perltidy to add certain whitespace to improve code readability. This is the default. If you do not want any whitespace added, but are willing to have some whitespace deleted, use <b>-naws</b>. (Use <b>-fws</b> to leave whitespace completely unchanged).</p>
 983
 984 </dd>
 985 <dt id="dws---delete-old-whitespace"><b>-dws</b>, <b>--delete-old-whitespace</b></dt>
 986 <dd>
 987
 988 <p>Setting this option allows perltidy to remove some old whitespace between characters, if necessary. This is the default. If you do not want any old whitespace removed, use <b>-ndws</b> or <b>--nodelete-old-whitespace</b>.</p>
 989
 990 </dd>
 991 <dt id="Detailed-whitespace-controls-around-tokens"><b>Detailed whitespace controls around tokens</b></dt>
 992 <dd>
 993
 994 <p>For those who want more detailed control over the whitespace around tokens, there are four parameters which can directly modify the default whitespace rules built into perltidy for any token. They are:</p>
 995
 996 <p><b>-wls=s</b> or <b>--want-left-space=s</b>,</p>
 997
 998 <p><b>-nwls=s</b> or <b>--nowant-left-space=s</b>,</p>
 999
1000 <p><b>-wrs=s</b> or <b>--want-right-space=s</b>,</p>
1001
1002 <p><b>-nwrs=s</b> or <b>--nowant-right-space=s</b>.</p>
1003
1004 <p>These parameters are each followed by a quoted string, <b>s</b>, containing a list of token types. No more than one of each of these parameters should be specified, because repeating a command-line parameter always overwrites the previous one before perltidy ever sees it.</p>
1005
1006 <p>To illustrate how these are used, suppose it is desired that there be no space on either side of the token types <b>= + - / *</b>. The following two parameters would specify this desire:</p>
1007
1008 <pre><code>  -nwls=&quot;= + - / *&quot;    -nwrs=&quot;= + - / *&quot;</code></pre>
1009
1010 <p>(Note that the token types are in quotes, and that they are separated by spaces). With these modified whitespace rules, the following line of math:</p>
1011
1012 <pre><code>  $root = -$b + sqrt( $b * $b - 4. * $a * $c ) / ( 2. * $a );</code></pre>
1013
1014 <p>becomes this:</p>
1015
1016 <pre><code>  $root=-$b+sqrt( $b*$b-4.*$a*$c )/( 2.*$a );</code></pre>
1017
1018 <p>These parameters should be considered to be hints to perltidy rather than fixed rules, because perltidy must try to resolve conflicts that arise between them and all of the other rules that it uses. One conflict that can arise is if, between two tokens, the left token wants a space and the right one doesn&#39;t. In this case, the token not wanting a space takes priority.</p>
1019
1020 <p>It is necessary to have a list of all token types in order to create this type of input. Such a list can be obtained by the command <b>--dump-token-types</b>. Also try the <b>-D</b> flag on a short snippet of code and look at the .DEBUG file to see the tokenization.</p>
1021
1022 <p><b>WARNING</b> Be sure to put these tokens in quotes to avoid having them misinterpreted by your command shell.</p>
1023
1024 </dd>
1025 <dt id="Note1:-Perltidy-does-always-follow-whitespace-controls"><b>Note1: Perltidy does always follow whitespace controls</b></dt>
1026 <dd>
1027
1028 <p>The various parameters controlling whitespace within a program are requests which perltidy follows as well as possible, but there are a number of situations where changing whitespace could change program behavior and is not done. Some of these are obvious; for example, we should not remove the space between the two plus symbols in &#39;$x+ +$y&#39; to avoid creating a &#39;++&#39; operator. Some are more subtle and involve the whitespace around bareword symbols and locations of possible filehandles. For example, consider the problem of formatting the following subroutine:</p>
1029
1030 <pre><code>   sub print_div {
1031       my ($x,$y)=@_;
1032       print $x/$y;
1033    }</code></pre>
1034
1035 <p>Suppose the user requests that / signs have a space to the left but not to the right. Perltidy will refuse to do this, but if this were done the result would be</p>
1036
1037 <pre><code>   sub print_div {
1038        my ($x,$y)=@_;
1039        print $x /$y;
1040    }</code></pre>
1041
1042 <p>If formatted in this way, the program will not run (at least with recent versions of perl) because the $x is taken to be a filehandle and / is assumed to start a quote. In a complex program, there might happen to be a / which terminates the multiline quote without a syntax error, allowing the program to run, but not as intended.</p>
1043
1044 <p>Related issues arise with other binary operator symbols, such as + and -, and in older versions of perl there could be problems with ternary operators. So to avoid changing program behavior, perltidy has the simple rule that whitespace around possible filehandles is left unchanged. Likewise, whitespace around barewords is left unchanged. The reason is that if the barewords are defined in other modules, or in code that has not even been written yet, perltidy will not have seen their prototypes and must treat them cautiously.</p>
1045
1046 <p>In perltidy this is implemented in the tokenizer by marking token following a <b>print</b> keyword as a special type <b>Z</b>. When formatting is being done, whitespace following this token type is generally left unchanged as a precaution against changing program behavior. This is excessively conservative but simple and easy to implement. Keywords which are treated similarly to <b>print</b> include <b>printf</b>, <b>sort</b>, <b>exec</b>, <b>system</b>. Changes in spacing around parameters following these keywords may have to be made manually. For example, the space, or lack of space, after the parameter $foo in the following line will be unchanged in formatting.</p>
1047
1048 <pre><code>   system($foo );
1049    system($foo);</code></pre>
1050
1051 <p>To find if a token is of type <b>Z</b> you can use <b>perltidy -DEBUG</b>. For the first line above the result is</p>
1052
1053 <pre><code>   1: system($foo );
1054    1: kkkkkk{ZZZZb};</code></pre>
1055
1056 <p>which shows that <b>system</b> is type <b>k</b> (keyword) and $foo is type <b>Z</b>.</p>
1057
1058 </dd>
1059 <dt id="Note2:-Perltidys-whitespace-rules-are-not-perfect"><b>Note2: Perltidy&#39;s whitespace rules are not perfect</b></dt>
1060 <dd>
1061
1062 <p>Despite these precautions, it is still possible to introduce syntax errors with some asymmetric whitespace rules, particularly when call parameters are not placed in containing parens or braces. For example, the following two lines will be parsed by perl without a syntax error:</p>
1063
1064 <pre><code>  # original programming, syntax ok
1065   my @newkeys = map $_-$nrecs+@data, @oldkeys;
1066
1067   # perltidy default, syntax ok
1068   my @newkeys = map $_ - $nrecs + @data, @oldkeys;</code></pre>
1069
1070 <p>But the following will give a syntax error:</p>
1071
1072 <pre><code>  # perltidy -nwrs=&#39;-&#39;
1073   my @newkeys = map $_ -$nrecs + @data, @oldkeys;</code></pre>
1074
1075 <p>For another example, the following two lines will be parsed without syntax error:</p>
1076
1077 <pre><code>  # original programming, syntax ok
1078   for my $severity ( reverse $SEVERITY_LOWEST+1 .. $SEVERITY_HIGHEST ) { ...  }
1079
1080   # perltidy default, syntax ok
1081   for my $severity ( reverse $SEVERITY_LOWEST + 1 .. $SEVERITY_HIGHEST ) { ... }</code></pre>
1082
1083 <p>But the following will give a syntax error:</p>
1084
1085 <pre><code>  # perltidy -nwrs=&#39;+&#39;, syntax error:
1086   for my $severity ( reverse $SEVERITY_LOWEST +1 .. $SEVERITY_HIGHEST ) { ... }</code></pre>
1087
1088 <p>To avoid subtle parsing problems like this, it is best to avoid spacing a binary operator asymmetrically with a space on the left but not on the right.</p>
1089
1090 </dd>
1091 <dt id="Space-between-specific-keywords-and-opening-paren"><b>Space between specific keywords and opening paren</b></dt>
1092 <dd>
1093
1094 <p>When an opening paren follows a Perl keyword, no space is introduced after the keyword, unless it is (by default) one of these:</p>
1095
1096 <pre><code>   my local our and or xor eq ne if else elsif until unless
1097    while for foreach return switch case given when</code></pre>
1098
1099 <p>These defaults can be modified with two commands:</p>
1100
1101 <p><b>-sak=s</b> or <b>--space-after-keyword=s</b> adds keywords.</p>
1102
1103 <p><b>-nsak=s</b> or <b>--nospace-after-keyword=s</b> removes keywords.</p>
1104
1105 <p>where <b>s</b> is a list of keywords (in quotes if necessary). For example,</p>
1106
1107 <pre><code>  my ( $a, $b, $c ) = @_;    # default
1108   my( $a, $b, $c ) = @_;     # -nsak=&quot;my local our&quot;</code></pre>
1109
1110 <p>The abbreviation <b>-nsak=&#39;*&#39;</b> is equivalent to including all of the keywords in the above list.</p>
1111
1112 <p>When both <b>-nsak=s</b> and <b>-sak=s</b> commands are included, the <b>-nsak=s</b> command is executed first. For example, to have space after only the keywords (my, local, our) you could use <b>-nsak=&quot;*&quot; -sak=&quot;my local our&quot;</b>.</p>
1113
1114 <p>To put a space after all keywords, see the next item.</p>
1115
1116 </dd>
1117 <dt id="Space-between-all-keywords-and-opening-parens"><b>Space between all keywords and opening parens</b></dt>
1118 <dd>
1119
1120 <p>When an opening paren follows a function or keyword, no space is introduced after the keyword except for the keywords noted in the previous item. To always put a space between a function or keyword and its opening paren, use the command:</p>
1121
1122 <p><b>-skp</b> or <b>--space-keyword-paren</b></p>
1123
1124 <p>You may also want to use the flag <b>-sfp</b> (next item) too.</p>
1125
1126 </dd>
1127 <dt id="Space-between-all-function-names-and-opening-parens"><b>Space between all function names and opening parens</b></dt>
1128 <dd>
1129
1130 <p>When an opening paren follows a function the default and recommended formatting is not to introduce a space. To cause a space to be introduced use:</p>
1131
1132 <p><b>-sfp</b> or <b>--space-function-paren</b></p>
1133
1134 <pre><code>  myfunc( $a, $b, $c );    # default
1135   myfunc ( $a, $b, $c );   # -sfp</code></pre>
1136
1137 <p>You will probably also want to use the flag <b>-skp</b> (previous item) too.</p>
1138
1139 <p>The parameter is not recommended because spacing a function paren can make a program vulnerable to parsing problems by Perl. For example, the following two-line program will run as written but will have a syntax error if reformatted with -sfp:</p>
1140
1141 <pre><code>  if ( -e filename() ) { print &quot;I&#39;m here\n&quot;; }
1142   sub filename { return $0 }</code></pre>
1143
1144 <p>In this particular case the syntax error can be removed if the line order is reversed, so that Perl parses &#39;sub filename&#39; first.</p>
1145
1146 </dd>
1147 <dt id="fpva-or---function-paren-vertical-alignment"><b>-fpva</b> or <b>--function-paren-vertical-alignment</b></dt>
1148 <dd>
1149
1150 <p>A side-effect of using the <b>-sfp</b> flag is that the parens may become vertically aligned. For example,</p>
1151
1152 <pre><code>    # perltidy -sfp
1153     myfun     ( $aaa, $b, $cc );
1154     mylongfun ( $a, $b, $c );</code></pre>
1155
1156 <p>This is the default behavior. To prevent this alignment use <b>-nfpva</b>:</p>
1157
1158 <pre><code>    # perltidy -sfp -nfpva
1159     myfun ( $aaa, $b, $cc );
1160     mylongfun ( $a, $b, $c );</code></pre>
1161
1162 </dd>
1163 <dt id="spp-n-or---space-prototype-paren-n"><b>-spp=n</b> or <b>--space-prototype-paren=n</b></dt>
1164 <dd>
1165
1166 <p>This flag can be used to control whether a function prototype is preceded by a space. For example, the following prototype does not have a space.</p>
1167
1168 <pre><code>      sub usage();</code></pre>
1169
1170 <p>This integer <b>n</b> may have the value 0, 1, or 2 as follows:</p>
1171
1172 <pre><code>    -spp=0 means no space before the paren
1173     -spp=1 means follow the example of the source code [DEFAULT]
1174     -spp=2 means always put a space before the paren</code></pre>
1175
1176 <p>The default is <b>-spp=1</b>, meaning that a space will be used if and only if there is one in the source code. Given the above line of code, the result of applying the different options would be:</p>
1177
1178 <pre><code>        sub usage();    # n=0 [no space]
1179         sub usage();    # n=1 [default; follows input]
1180         sub usage ();   # n=2 [space]</code></pre>
1181
1182 </dd>
1183 <dt id="kpit-n-or---keyword-paren-inner-tightness-n"><b>-kpit=n</b> or <b>--keyword-paren-inner-tightness=n</b></dt>
1184 <dd>
1185
1186 <p>The space inside of an opening paren, which itself follows a certain keyword, can be controlled by this parameter. The space on the inside of the corresponding closing paren will be treated in the same (balanced) manner. This parameter has precedence over any other paren spacing rules. The values of <b>n</b> are as follows:</p>
1187
1188 <pre><code>   -kpit=0 means always put a space (not tight)
1189    -kpit=1 means ignore this parameter [default]
1190    -kpit=2 means never put a space (tight)</code></pre>
1191
1192 <p>To illustrate, the following snippet is shown formatted in three ways:</p>
1193
1194 <pre><code>    if ( seek( DATA, 0, 0 ) ) { ... }    # perltidy (default)
1195     if (seek(DATA, 0, 0)) { ... }        # perltidy -pt=2
1196     if ( seek(DATA, 0, 0) ) { ... }      # perltidy -pt=2 -kpit=0</code></pre>
1197
1198 <p>In the second case the -pt=2 parameter makes all of the parens tight. In the third case the -kpit=0 flag causes the space within the &#39;if&#39; parens to have a space, since &#39;if&#39; is one of the keywords to which the -kpit flag applies by default. The remaining parens are still tight because of the -pt=2 parameter.</p>
1199
1200 <p>The set of keywords to which this parameter applies are by default are:</p>
1201
1202 <pre><code>   if elsif unless while until for foreach</code></pre>
1203
1204 <p>These can be changed with the parameter <b>-kpitl=s</b> described in the next section.</p>
1205
1206 </dd>
1207 <dt id="kpitl-string-or---keyword-paren-inner-tightness-string"><b>-kpitl=string</b> or <b>--keyword-paren-inner-tightness=string</b></dt>
1208 <dd>
1209
1210 <p>This command can be used to change the keywords to which the the <b>-kpit=n</b> command applies. The parameter <b>string</b> is a required list either keywords or functions, which should be placed in quotes if there are more than one. By itself, this parameter does not cause any change in spacing, so the <b>-kpit=n</b> command is still required.</p>
1211
1212 <p>For example, the commands <code>-kpitl=&quot;if else while&quot; -kpit=2</code> will cause the just the spaces inside parens following &#39;if&#39;, &#39;else&#39;, and &#39;while&#39; keywords to follow the tightness value indicated by the <b>-kpit=2</b> flag.</p>
1213
1214 </dd>
1215 <dt id="lop-or---logical-padding"><b>-lop</b> or <b>--logical-padding</b></dt>
1216 <dd>
1217
1218 <p>In the following example some extra space has been inserted on the second line between the two open parens. This extra space is called &quot;logical padding&quot; and is intended to help align similar things vertically in some logical or ternary expressions.</p>
1219
1220 <pre><code>    # perltidy [default formatting]
1221     $same =
1222       (      ( $aP eq $bP )
1223           &amp;&amp; ( $aS eq $bS )
1224           &amp;&amp; ( $aT eq $bT )
1225           &amp;&amp; ( $a-&gt;{&#39;title&#39;} eq $b-&gt;{&#39;title&#39;} )
1226           &amp;&amp; ( $a-&gt;{&#39;href&#39;} eq $b-&gt;{&#39;href&#39;} ) );</code></pre>
1227
1228 <p>Note that this is considered to be a different operation from &quot;vertical alignment&quot; because space at just one line is being adjusted, whereas in &quot;vertical alignment&quot; the spaces at all lines are being adjusted. So it sort of a local version of vertical alignment.</p>
1229
1230 <p>Here is an example involving a ternary operator:</p>
1231
1232 <pre><code>    # perltidy [default formatting]
1233     $bits =
1234         $top &gt; 0xffff ? 32
1235       : $top &gt; 0xff   ? 16
1236       : $top &gt; 1      ? 8
1237       :                 1;</code></pre>
1238
1239 <p>This behavior is controlled with the flag <b>--logical-padding</b>, which is set &#39;on&#39; by default. If it is not desired it can be turned off using <b>--nological-padding</b> or <b>-nlop</b>. The above two examples become, with <b>-nlop</b>:</p>
1240
1241 <pre><code>    # perltidy -nlop
1242     $same =
1243       ( ( $aP eq $bP )
1244           &amp;&amp; ( $aS eq $bS )
1245           &amp;&amp; ( $aT eq $bT )
1246           &amp;&amp; ( $a-&gt;{&#39;title&#39;} eq $b-&gt;{&#39;title&#39;} )
1247           &amp;&amp; ( $a-&gt;{&#39;href&#39;} eq $b-&gt;{&#39;href&#39;} ) );
1248
1249     # perltidy -nlop
1250     $bits =
1251       $top &gt; 0xffff ? 32
1252       : $top &gt; 0xff ? 16
1253       : $top &gt; 1    ? 8
1254       :               1;</code></pre>
1255
1256 </dd>
1257 <dt id="Trimming-whitespace-around-qw-quotes"><b>Trimming whitespace around <code>qw</code> quotes</b></dt>
1258 <dd>
1259
1260 <p><b>-tqw</b> or <b>--trim-qw</b> provide the default behavior of trimming spaces around multi-line <code>qw</code> quotes and indenting them appropriately.</p>
1261
1262 <p><b>-ntqw</b> or <b>--notrim-qw</b> cause leading and trailing whitespace around multi-line <code>qw</code> quotes to be left unchanged. This option will not normally be necessary, but was added for testing purposes, because in some versions of perl, trimming <code>qw</code> quotes changes the syntax tree.</p>
1263
1264 </dd>
1265 <dt id="sbq-n-or---space-backslash-quote-n"><b>-sbq=n</b> or <b>--space-backslash-quote=n</b></dt>
1266 <dd>
1267
1268 <p>lines like</p>
1269
1270 <pre><code>       $str1=\&quot;string1&quot;;
1271        $str2=\&#39;string2&#39;;</code></pre>
1272
1273 <p>can confuse syntax highlighters unless a space is included between the backslash and the single or double quotation mark.</p>
1274
1275 <p>this can be controlled with the value of <b>n</b> as follows:</p>
1276
1277 <pre><code>    -sbq=0 means no space between the backslash and quote
1278     -sbq=1 means follow the example of the source code
1279     -sbq=2 means always put a space between the backslash and quote</code></pre>
1280
1281 <p>The default is <b>-sbq=1</b>, meaning that a space will be used if there is one in the source code.</p>
1282
1283 </dd>
1284 <dt id="Trimming-trailing-whitespace-from-lines-of-POD"><b>Trimming trailing whitespace from lines of POD</b></dt>
1285 <dd>
1286
1287 <p><b>-trp</b> or <b>--trim-pod</b> will remove trailing whitespace from lines of POD. The default is not to do this.</p>
1288
1289 </dd>
1290 </dl>
1291
1292 <h2 id="Comment-Controls">Comment Controls</h2>
1293
1294 <p>Perltidy has a number of ways to control the appearance of both block comments and side comments. The term <b>block comment</b> here refers to a full-line comment, whereas <b>side comment</b> will refer to a comment which appears on a line to the right of some code.</p>
1295
1296 <dl>
1297
1298 <dt id="ibc---indent-block-comments"><b>-ibc</b>, <b>--indent-block-comments</b></dt>
1299 <dd>
1300
1301 <p>Block comments normally look best when they are indented to the same level as the code which follows them. This is the default behavior, but you may use <b>-nibc</b> to keep block comments left-justified. Here is an example:</p>
1302
1303 <pre><code>             # this comment is indented      (-ibc, default)
1304              if ($task) { yyy(); }</code></pre>
1305
1306 <p>The alternative is <b>-nibc</b>:</p>
1307
1308 <pre><code> # this comment is not indented              (-nibc)
1309              if ($task) { yyy(); }</code></pre>
1310
1311 <p>See also the next item, <b>-isbc</b>, as well as <b>-sbc</b>, for other ways to have some indented and some outdented block comments.</p>
1312
1313 </dd>
1314 <dt id="isbc---indent-spaced-block-comments"><b>-isbc</b>, <b>--indent-spaced-block-comments</b></dt>
1315 <dd>
1316
1317 <p>If there is no leading space on the line, then the comment will not be indented, and otherwise it may be.</p>
1318
1319 <p>If both <b>-ibc</b> and <b>-isbc</b> are set, then <b>-isbc</b> takes priority.</p>
1320
1321 </dd>
1322 <dt id="olc---outdent-long-comments"><b>-olc</b>, <b>--outdent-long-comments</b></dt>
1323 <dd>
1324
1325 <p>When <b>-olc</b> is set, lines which are full-line (block) comments longer than the value <b>maximum-line-length</b> will have their indentation removed. This is the default; use <b>-nolc</b> to prevent outdenting.</p>
1326
1327 </dd>
1328 <dt id="msc-n---minimum-space-to-comment-n"><b>-msc=n</b>, <b>--minimum-space-to-comment=n</b></dt>
1329 <dd>
1330
1331 <p>Side comments look best when lined up several spaces to the right of code. Perltidy will try to keep comments at least n spaces to the right. The default is n=4 spaces.</p>
1332
1333 </dd>
1334 <dt id="fpsc-n---fixed-position-side-comment-n"><b>-fpsc=n</b>, <b>--fixed-position-side-comment=n</b></dt>
1335 <dd>
1336
1337 <p>This parameter tells perltidy to line up side comments in column number <b>n</b> whenever possible. The default, n=0, will not do this.</p>
1338
1339 </dd>
1340 <dt id="iscl---ignore-side-comment-lengths"><b>-iscl</b>, <b>--ignore-side-comment-lengths</b></dt>
1341 <dd>
1342
1343 <p>This parameter causes perltidy to ignore the length of side comments when setting line breaks. The default, <b>-niscl</b>, is to include the length of side comments when breaking lines to stay within the length prescribed by the <b>-l=n</b> maximum line length parameter. For example, the following long single line would remain intact with -l=80 and -iscl:</p>
1344
1345 <pre><code>     perltidy -l=80 -iscl
1346         $vmsfile =~ s/;[\d\-]*$//; # Clip off version number; we can use a newer version as well</code></pre>
1347
1348 <p>whereas without the -iscl flag the line will be broken:</p>
1349
1350 <pre><code>     perltidy -l=80
1351         $vmsfile =~ s/;[\d\-]*$//
1352           ;    # Clip off version number; we can use a newer version as well</code></pre>
1353
1354 </dd>
1355 <dt id="hsc---hanging-side-comments"><b>-hsc</b>, <b>--hanging-side-comments</b></dt>
1356 <dd>
1357
1358 <p>By default, perltidy tries to identify and align &quot;hanging side comments&quot;, which are something like this:</p>
1359
1360 <pre><code>        my $IGNORE = 0;    # This is a side comment
1361                            # This is a hanging side comment
1362                            # And so is this</code></pre>
1363
1364 <p>A comment is considered to be a hanging side comment if (1) it immediately follows a line with a side comment, or another hanging side comment, and (2) there is some leading whitespace on the line. To deactivate this feature, use <b>-nhsc</b> or <b>--nohanging-side-comments</b>. If block comments are preceded by a blank line, or have no leading whitespace, they will not be mistaken as hanging side comments.</p>
1365
1366 </dd>
1367 <dt id="Closing-Side-Comments"><b>Closing Side Comments</b></dt>
1368 <dd>
1369
1370 <p>A closing side comment is a special comment which perltidy can automatically create and place after the closing brace of a code block. They can be useful for code maintenance and debugging. The command <b>-csc</b> (or <b>--closing-side-comments</b>) adds or updates closing side comments. For example, here is a small code snippet</p>
1371
1372 <pre><code>        sub message {
1373             if ( !defined( $_[0] ) ) {
1374                 print(&quot;Hello, World\n&quot;);
1375             }
1376             else {
1377                 print( $_[0], &quot;\n&quot; );
1378             }
1379         }</code></pre>
1380
1381 <p>And here is the result of processing with <code>perltidy -csc</code>:</p>
1382
1383 <pre><code>        sub message {
1384             if ( !defined( $_[0] ) ) {
1385                 print(&quot;Hello, World\n&quot;);
1386             }
1387             else {
1388                 print( $_[0], &quot;\n&quot; );
1389             }
1390         } ## end sub message</code></pre>
1391
1392 <p>A closing side comment was added for <code>sub message</code> in this case, but not for the <code>if</code> and <code>else</code> blocks, because they were below the 6 line cutoff limit for adding closing side comments. This limit may be changed with the <b>-csci</b> command, described below.</p>
1393
1394 <p>The command <b>-dcsc</b> (or <b>--delete-closing-side-comments</b>) reverses this process and removes these comments.</p>
1395
1396 <p>Several commands are available to modify the behavior of these two basic commands, <b>-csc</b> and <b>-dcsc</b>:</p>
1397
1398 <dl>
1399
1400 <dt id="csci-n-or---closing-side-comment-interval-n"><b>-csci=n</b>, or <b>--closing-side-comment-interval=n</b></dt>
1401 <dd>
1402
1403 <p>where <code>n</code> is the minimum number of lines that a block must have in order for a closing side comment to be added. The default value is <code>n=6</code>. To illustrate:</p>
1404
1405 <pre><code>        # perltidy -csci=2 -csc
1406         sub message {
1407             if ( !defined( $_[0] ) ) {
1408                 print(&quot;Hello, World\n&quot;);
1409             } ## end if ( !defined( $_[0] ))
1410             else {
1411                 print( $_[0], &quot;\n&quot; );
1412             } ## end else [ if ( !defined( $_[0] ))
1413         } ## end sub message</code></pre>
1414
1415 <p>Now the <code>if</code> and <code>else</code> blocks are commented. However, now this has become very cluttered.</p>
1416
1417 </dd>
1418 <dt id="cscp-string-or---closing-side-comment-prefix-string"><b>-cscp=string</b>, or <b>--closing-side-comment-prefix=string</b></dt>
1419 <dd>
1420
1421 <p>where string is the prefix used before the name of the block type. The default prefix, shown above, is <code>## end</code>. This string will be added to closing side comments, and it will also be used to recognize them in order to update, delete, and format them. Any comment identified as a closing side comment will be placed just a single space to the right of its closing brace.</p>
1422
1423 </dd>
1424 <dt id="cscl-string-or---closing-side-comment-list"><b>-cscl=string</b>, or <b>--closing-side-comment-list</b></dt>
1425 <dd>
1426
1427 <p>where <code>string</code> is a list of block types to be tagged with closing side comments. By default, all code block types preceded by a keyword or label (such as <code>if</code>, <code>sub</code>, and so on) will be tagged. The <b>-cscl</b> command changes the default list to be any selected block types; see <a href="#Specifying-Block-Types">&quot;Specifying Block Types&quot;</a>. For example, the following command requests that only <code>sub</code>&#39;s, labels, <code>BEGIN</code>, and <code>END</code> blocks be affected by any <b>-csc</b> or <b>-dcsc</b> operation:</p>
1428
1429 <pre><code>   -cscl=&quot;sub : BEGIN END&quot;</code></pre>
1430
1431 </dd>
1432 <dt id="csct-n-or---closing-side-comment-maximum-text-n"><b>-csct=n</b>, or <b>--closing-side-comment-maximum-text=n</b></dt>
1433 <dd>
1434
1435 <p>The text appended to certain block types, such as an <code>if</code> block, is whatever lies between the keyword introducing the block, such as <code>if</code>, and the opening brace. Since this might be too much text for a side comment, there needs to be a limit, and that is the purpose of this parameter. The default value is <code>n=20</code>, meaning that no additional tokens will be appended to this text after its length reaches 20 characters. Omitted text is indicated with <code>...</code>. (Tokens, including sub names, are never truncated, however, so actual lengths may exceed this). To illustrate, in the above example, the appended text of the first block is <code> ( !defined( $_[0] )...</code>. The existing limit of <code>n=20</code> caused this text to be truncated, as indicated by the <code>...</code>. See the next flag for additional control of the abbreviated text.</p>
1436
1437 </dd>
1438 <dt id="cscb-or---closing-side-comments-balanced"><b>-cscb</b>, or <b>--closing-side-comments-balanced</b></dt>
1439 <dd>
1440
1441 <p>As discussed in the previous item, when the closing-side-comment-maximum-text limit is exceeded the comment text must be truncated. Older versions of perltidy terminated with three dots, and this can still be achieved with -ncscb:</p>
1442
1443 <pre><code>  perltidy -csc -ncscb
1444   } ## end foreach my $foo (sort { $b cmp $a ...</code></pre>
1445
1446 <p>However this causes a problem with editors which cannot recognize comments or are not configured to do so because they cannot &quot;bounce&quot; around in the text correctly. The <b>-cscb</b> flag has been added to help them by appending appropriate balancing structure:</p>
1447
1448 <pre><code>  perltidy -csc -cscb
1449   } ## end foreach my $foo (sort { $b cmp $a ... })</code></pre>
1450
1451 <p>The default is <b>-cscb</b>.</p>
1452
1453 </dd>
1454 <dt id="csce-n-or---closing-side-comment-else-flag-n"><b>-csce=n</b>, or <b>--closing-side-comment-else-flag=n</b></dt>
1455 <dd>
1456
1457 <p>The default, <b>n=0</b>, places the text of the opening <code>if</code> statement after any terminal <code>else</code>.</p>
1458
1459 <p>If <b>n=2</b> is used, then each <code>elsif</code> is also given the text of the opening <code>if</code> statement. Also, an <code>else</code> will include the text of a preceding <code>elsif</code> statement. Note that this may result some long closing side comments.</p>
1460
1461 <p>If <b>n=1</b> is used, the results will be the same as <b>n=2</b> whenever the resulting line length is less than the maximum allowed.</p>
1462
1463 </dd>
1464 <dt id="cscb-or---closing-side-comments-balanced1"><b>-cscb</b>, or <b>--closing-side-comments-balanced</b></dt>
1465 <dd>
1466
1467 <p>When using closing-side-comments, and the closing-side-comment-maximum-text limit is exceeded, then the comment text must be abbreviated. It is terminated with three dots if the <b>-cscb</b> flag is negated:</p>
1468
1469 <pre><code>  perltidy -csc -ncscb
1470   } ## end foreach my $foo (sort { $b cmp $a ...</code></pre>
1471
1472 <p>This causes a problem with older editors which do not recognize comments because they cannot &quot;bounce&quot; around in the text correctly. The <b>-cscb</b> flag tries to help them by appending appropriate terminal balancing structures:</p>
1473
1474 <pre><code>  perltidy -csc -cscb
1475   } ## end foreach my $foo (sort { $b cmp $a ... })</code></pre>
1476
1477 <p>The default is <b>-cscb</b>.</p>
1478
1479 </dd>
1480 <dt id="cscw-or---closing-side-comment-warnings"><b>-cscw</b>, or <b>--closing-side-comment-warnings</b></dt>
1481 <dd>
1482
1483 <p>This parameter is intended to help make the initial transition to the use of closing side comments. It causes two things to happen if a closing side comment replaces an existing, different closing side comment: first, an error message will be issued, and second, the original side comment will be placed alone on a new specially marked comment line for later attention.</p>
1484
1485 <p>The intent is to avoid clobbering existing hand-written side comments which happen to match the pattern of closing side comments. This flag should only be needed on the first run with <b>-csc</b>.</p>
1486
1487 </dd>
1488 </dl>
1489
1490 <p><b>Important Notes on Closing Side Comments:</b></p>
1491
1492 <ul>
1493
1494 <li><p>Closing side comments are only placed on lines terminated with a closing brace. Certain closing styles, such as the use of cuddled elses (<b>-ce</b>), preclude the generation of some closing side comments.</p>
1495
1496 </li>
1497 <li><p>Please note that adding or deleting of closing side comments takes place only through the commands <b>-csc</b> or <b>-dcsc</b>. The other commands, if used, merely modify the behavior of these two commands.</p>
1498
1499 </li>
1500 <li><p>It is recommended that the <b>-cscw</b> flag be used along with <b>-csc</b> on the first use of perltidy on a given file. This will prevent loss of any existing side comment data which happens to have the csc prefix.</p>
1501
1502 </li>
1503 <li><p>Once you use <b>-csc</b>, you should continue to use it so that any closing side comments remain correct as code changes. Otherwise, these comments will become incorrect as the code is updated.</p>
1504
1505 </li>
1506 <li><p>If you edit the closing side comments generated by perltidy, you must also change the prefix to be different from the closing side comment prefix. Otherwise, your edits will be lost when you rerun perltidy with <b>-csc</b>. For example, you could simply change <code>## end</code> to be <code>## End</code>, since the test is case sensitive. You may also want to use the <b>-ssc</b> flag to keep these modified closing side comments spaced the same as actual closing side comments.</p>
1507
1508 </li>
1509 <li><p>Temporarily generating closing side comments is a useful technique for exploring and/or debugging a perl script, especially one written by someone else. You can always remove them with <b>-dcsc</b>.</p>
1510
1511 </li>
1512 </ul>
1513
1514 </dd>
1515 <dt id="Static-Block-Comments"><b>Static Block Comments</b></dt>
1516 <dd>
1517
1518 <p>Static block comments are block comments with a special leading pattern, <code>##</code> by default, which will be treated slightly differently from other block comments. They effectively behave as if they had glue along their left and top edges, because they stick to the left edge and previous line when there is no blank spaces in those places. This option is particularly useful for controlling how commented code is displayed.</p>
1519
1520 <dl>
1521
1522 <dt id="sbc---static-block-comments"><b>-sbc</b>, <b>--static-block-comments</b></dt>
1523 <dd>
1524
1525 <p>When <b>-sbc</b> is used, a block comment with a special leading pattern, <code>##</code> by default, will be treated specially.</p>
1526
1527 <p>Comments so identified are treated as follows:</p>
1528
1529 <ul>
1530
1531 <li><p>If there is no leading space on the line, then the comment will not be indented, and otherwise it may be,</p>
1532
1533 </li>
1534 <li><p>no new blank line will be inserted before such a comment, and</p>
1535
1536 </li>
1537 <li><p>such a comment will never become a hanging side comment.</p>
1538
1539 </li>
1540 </ul>
1541
1542 <p>For example, assuming <code>@month_of_year</code> is left-adjusted:</p>
1543
1544 <pre><code>    @month_of_year = (    # -sbc (default)
1545         &#39;Jan&#39;, &#39;Feb&#39;, &#39;Mar&#39;, &#39;Apr&#39;, &#39;May&#39;, &#39;Jun&#39;, &#39;Jul&#39;, &#39;Aug&#39;, &#39;Sep&#39;, &#39;Oct&#39;,
1546     ##  &#39;Dec&#39;, &#39;Nov&#39;
1547         &#39;Nov&#39;, &#39;Dec&#39;);</code></pre>
1548
1549 <p>Without this convention, the above code would become</p>
1550
1551 <pre><code>    @month_of_year = (   # -nsbc
1552         &#39;Jan&#39;, &#39;Feb&#39;, &#39;Mar&#39;, &#39;Apr&#39;, &#39;May&#39;, &#39;Jun&#39;, &#39;Jul&#39;, &#39;Aug&#39;, &#39;Sep&#39;, &#39;Oct&#39;,
1553
1554         ##  &#39;Dec&#39;, &#39;Nov&#39;
1555         &#39;Nov&#39;, &#39;Dec&#39;
1556     );</code></pre>
1557
1558 <p>which is not as clear. The default is to use <b>-sbc</b>. This may be deactivated with <b>-nsbc</b>.</p>
1559
1560 </dd>
1561 <dt id="sbcp-string---static-block-comment-prefix-string"><b>-sbcp=string</b>, <b>--static-block-comment-prefix=string</b></dt>
1562 <dd>
1563
1564 <p>This parameter defines the prefix used to identify static block comments when the <b>-sbc</b> parameter is set. The default prefix is <code>##</code>, corresponding to <code>-sbcp=##</code>. The prefix is actually part of a perl pattern used to match lines and it must either begin with <code>#</code> or <code>^#</code>. In the first case a prefix ^\s* will be added to match any leading whitespace, while in the second case the pattern will match only comments with no leading whitespace. For example, to identify all comments as static block comments, one would use <code>-sbcp=#</code>. To identify all left-adjusted comments as static block comments, use <code>-sbcp=&#39;^#&#39;</code>.</p>
1565
1566 <p>Please note that <b>-sbcp</b> merely defines the pattern used to identify static block comments; it will not be used unless the switch <b>-sbc</b> is set. Also, please be aware that since this string is used in a perl regular expression which identifies these comments, it must enable a valid regular expression to be formed.</p>
1567
1568 <p>A pattern which can be useful is:</p>
1569
1570 <pre><code>    -sbcp=^#{2,}[^\s#]</code></pre>
1571
1572 <p>This pattern requires a static block comment to have at least one character which is neither a # nor a space. It allows a line containing only &#39;#&#39; characters to be rejected as a static block comment. Such lines are often used at the start and end of header information in subroutines and should not be separated from the intervening comments, which typically begin with just a single &#39;#&#39;.</p>
1573
1574 </dd>
1575 <dt id="osbc---outdent-static-block-comments"><b>-osbc</b>, <b>--outdent-static-block-comments</b></dt>
1576 <dd>
1577
1578 <p>The command <b>-osbc</b> will cause static block comments to be outdented by 2 spaces (or whatever <b>-ci=n</b> has been set to), if possible.</p>
1579
1580 </dd>
1581 </dl>
1582
1583 </dd>
1584 <dt id="Static-Side-Comments"><b>Static Side Comments</b></dt>
1585 <dd>
1586
1587 <p>Static side comments are side comments with a special leading pattern. This option can be useful for controlling how commented code is displayed when it is a side comment.</p>
1588
1589 <dl>
1590
1591 <dt id="ssc---static-side-comments"><b>-ssc</b>, <b>--static-side-comments</b></dt>
1592 <dd>
1593
1594 <p>When <b>-ssc</b> is used, a side comment with a static leading pattern, which is <code>##</code> by default, will be spaced only a single space from previous character, and it will not be vertically aligned with other side comments.</p>
1595
1596 <p>The default is <b>-nssc</b>.</p>
1597
1598 </dd>
1599 <dt id="sscp-string---static-side-comment-prefix-string"><b>-sscp=string</b>, <b>--static-side-comment-prefix=string</b></dt>
1600 <dd>
1601
1602 <p>This parameter defines the prefix used to identify static side comments when the <b>-ssc</b> parameter is set. The default prefix is <code>##</code>, corresponding to <code>-sscp=##</code>.</p>
1603
1604 <p>Please note that <b>-sscp</b> merely defines the pattern used to identify static side comments; it will not be used unless the switch <b>-ssc</b> is set. Also, note that this string is used in a perl regular expression which identifies these comments, so it must enable a valid regular expression to be formed.</p>
1605
1606 </dd>
1607 </dl>
1608
1609 </dd>
1610 </dl>
1611
1612 <h2 id="Skipping-Selected-Sections-of-Code">Skipping Selected Sections of Code</h2>
1613
1614 <p>Selected lines of code may be passed verbatim to the output without any formatting by marking the starting and ending lines with special comments. There are two options for doing this. The first option is called <b>--format-skipping</b> or <b>-fs</b>, and the second option is called <b>--code-skipping</b> or <b>-cs</b>.</p>
1615
1616 <p>In both cases the lines of code will be output without any changes. The difference is that in <b>--format-skipping</b> perltidy will still parse the marked lines of code and check for errors, whereas in <b>--code-skipping</b> perltidy will simply pass the lines to the output without any checking.</p>
1617
1618 <p>Both of these features are enabled by default and are invoked with special comment markers. <b>--format-skipping</b> uses starting and ending markers &#39;#&lt;&lt;&lt;&#39; and &#39;#&gt;&gt;&gt;&#39;, like this:</p>
1619
1620 <pre><code> #&lt;&lt;&lt;  format skipping: do not let perltidy change my nice formatting
1621     my @list = (1,
1622                 1, 1,
1623                 1, 2, 1,
1624                 1, 3, 3, 1,
1625                 1, 4, 6, 4, 1,);
1626  #&gt;&gt;&gt;</code></pre>
1627
1628 <p><b>--code-skipping</b> uses starting and ending markers &#39;#&lt;&lt;V&#39; and &#39;#&gt;&gt;V&#39;, like this:</p>
1629
1630 <pre><code> #&lt;&lt;V  code skipping: perltidy will pass this verbatim without error checking
1631
1632     token ident_digit {
1633         [ [ &lt;?word&gt; | _ | &lt;?digit&gt; ] &lt;?ident_digit&gt;
1634         |   &lt;&#39;&#39;&gt;
1635         ]
1636     };
1637
1638  #&gt;&gt;V</code></pre>
1639
1640 <p>Additional text may appear on the special comment lines provided that it is separated from the marker by at least one space, as in the above examples.</p>
1641
1642 <p>Any number of code-skipping or format-skipping sections may appear in a file. If an opening code-skipping or format-skipping comment is not followed by a corresponding closing comment, then skipping continues to the end of the file. If a closing code-skipping or format-skipping comment appears in a file but does not follow a corresponding opening comment, then it is treated as an ordinary comment without any special meaning.</p>
1643
1644 <p>It is recommended to use <b>--code-skipping</b> only if you need to hide a block of an extended syntax which would produce errors if parsed by perltidy, and use <b>--format-skipping</b> otherwise. This is because the <b>--format-skipping</b> option provides the benefits of error checking, and there are essentially no limitations on which lines to which it can be applied. The <b>--code-skipping</b> option, on the other hand, does not do error checking and its use is more restrictive because the code which remains, after skipping the marked lines, must be syntactically correct code with balanced containers.</p>
1645
1646 <p>These features should be used sparingly to avoid littering code with markers, but they can be helpful for working around occasional problems.</p>
1647
1648 <p>Note that it may be possible to avoid the use of <b>--format-skipping</b> for the specific case of a comma-separated list of values, as in the above example, by simply inserting a blank or comment somewhere between the opening and closing parens. See the section <a href="#Controlling-List-Formatting">&quot;Controlling List Formatting&quot;</a>.</p>
1649
1650 <p>The following sections describe the available controls for these options. They should not normally be needed.</p>
1651
1652 <dl>
1653
1654 <dt id="fs---format-skipping"><b>-fs</b>, <b>--format-skipping</b></dt>
1655 <dd>
1656
1657 <p>As explained above, this flag, which is enabled by default, causes any code between special beginning and ending comment markers to be passed to the output without formatting. The code between the comments is still checked for errors however. The default beginning marker is #&lt;&lt;&lt; and the default ending marker is #&gt;&gt;&gt;.</p>
1658
1659 <p>Format skipping begins when a format skipping beginning comment is seen and continues until a format-skipping ending comment is found.</p>
1660
1661 <p>This feature can be disabled with <b>-nfs</b>. This should not normally be necessary.</p>
1662
1663 </dd>
1664 <dt id="fsb-string---format-skipping-begin-string"><b>-fsb=string</b>, <b>--format-skipping-begin=string</b></dt>
1665 <dd>
1666
1667 <p>This and the next parameter allow the special beginning and ending comments to be changed. However, it is recommended that they only be changed if there is a conflict between the default values and some other use. If they are used, it is recommended that they only be entered in a <b>.perltidyrc</b> file, rather than on a command line. This is because properly escaping these parameters on a command line can be difficult.</p>
1668
1669 <p>If changed comment markers do not appear to be working, use the <b>-log</b> flag and examine the <i>.LOG</i> file to see if and where they are being detected.</p>
1670
1671 <p>The <b>-fsb=string</b> parameter may be used to change the beginning marker for format skipping. The default is equivalent to -fsb=&#39;#&lt;&lt;&lt;&#39;. The string that you enter must begin with a # and should be in quotes as necessary to get past the command shell of your system. It is actually the leading text of a pattern that is constructed by appending a &#39;\s&#39;, so you must also include backslashes for characters to be taken literally rather than as patterns.</p>
1672
1673 <p>Some examples show how example strings become patterns:</p>
1674
1675 <pre><code> -fsb=&#39;#\{\{\{&#39; becomes /^#\{\{\{\s/  which matches  #{{{ but not #{{{{
1676  -fsb=&#39;#\*\*&#39;   becomes /^#\*\*\s/    which matches  #** but not #***
1677  -fsb=&#39;#\*{2,}&#39; becomes /^#\*{2,}\s/  which matches  #** and #*****</code></pre>
1678
1679 </dd>
1680 <dt id="fse-string---format-skipping-end-string"><b>-fse=string</b>, <b>--format-skipping-end=string</b></dt>
1681 <dd>
1682
1683 <p>The <b>-fse=string</b> is the corresponding parameter used to change the ending marker for format skipping. The default is equivalent to -fse=&#39;#&lt;&lt;&lt;&#39;.</p>
1684
1685 <p>The beginning and ending strings may be the same, but it is preferable to make them different for clarity.</p>
1686
1687 </dd>
1688 <dt id="cs---code-skipping"><b>-cs</b>, <b>--code-skipping</b></dt>
1689 <dd>
1690
1691 <p>As explained above, this flag, which is enabled by default, causes any code between special beginning and ending comment markers to be directly passed to the output without any error checking or formatting. Essentially, perltidy treats it as if it were a block of arbitrary text. The default beginning marker is #&lt;&lt;V and the default ending marker is #&gt;&gt;V.</p>
1692
1693 <p>This feature can be disabled with <b>-ncs</b>. This should not normally be necessary.</p>
1694
1695 </dd>
1696 <dt id="csb-string---code-skipping-begin-string"><b>-csb=string</b>, <b>--code-skipping-begin=string</b></dt>
1697 <dd>
1698
1699 <p>This may be used to change the beginning comment for a <b>--code-skipping</b> section, and its use is similar to the <b>-fsb=string</b>. The default is equivalent to -csb=&#39;#&lt;&lt;V&#39;.</p>
1700
1701 </dd>
1702 <dt id="cse-string---code-skipping-end-string"><b>-cse=string</b>, <b>--code-skipping-end=string</b></dt>
1703 <dd>
1704
1705 <p>This may be used to change the ending comment for a <b>--code-skipping</b> section, and its use is similar to the <b>-fse=string</b>. The default is equivalent to -cse=&#39;#&gt;&gt;V&#39;.</p>
1706
1707 </dd>
1708 </dl>
1709
1710 <h2 id="Line-Break-Control">Line Break Control</h2>
1711
1712 <p>The parameters in this and the next sections control breaks after non-blank lines of code. Blank lines are controlled separately by parameters in the section <a href="#Blank-Line-Control">&quot;Blank Line Control&quot;</a>.</p>
1713
1714 <dl>
1715
1716 <dt id="dnl---delete-old-newlines"><b>-dnl</b>, <b>--delete-old-newlines</b></dt>
1717 <dd>
1718
1719 <p>By default, perltidy first deletes all old line break locations, and then it looks for good break points to match the desired line length. Use <b>-ndnl</b> or <b>--nodelete-old-newlines</b> to force perltidy to retain all old line break points.</p>
1720
1721 </dd>
1722 <dt id="anl---add-newlines"><b>-anl</b>, <b>--add-newlines</b></dt>
1723 <dd>
1724
1725 <p>By default, perltidy will add line breaks when necessary to create continuations of long lines and to improve the script appearance. Use <b>-nanl</b> or <b>--noadd-newlines</b> to prevent any new line breaks.</p>
1726
1727 <p>This flag does not prevent perltidy from eliminating existing line breaks; see <b>--freeze-newlines</b> to completely prevent changes to line break points.</p>
1728
1729 </dd>
1730 <dt id="fnl---freeze-newlines"><b>-fnl</b>, <b>--freeze-newlines</b></dt>
1731 <dd>
1732
1733 <p>If you do not want any changes to the line breaks within lines of code in your script, set <b>-fnl</b>, and they will remain fixed, and the rest of the commands in this section and sections <a href="#Controlling-List-Formatting">&quot;Controlling List Formatting&quot;</a>, <a href="#Retaining-or-Ignoring-Existing-Line-Breaks">&quot;Retaining or Ignoring Existing Line Breaks&quot;</a>. You may want to use <b>-noll</b> with this.</p>
1734
1735 <p>Note: If you also want to keep your blank lines exactly as they are, you can use the <b>-fbl</b> flag which is described in the section <a href="#Blank-Line-Control">&quot;Blank Line Control&quot;</a>.</p>
1736
1737 </dd>
1738 </dl>
1739
1740 <h2 id="Controlling-Breaks-at-Braces-Parens-and-Square-Brackets">Controlling Breaks at Braces, Parens, and Square Brackets</h2>
1741
1742 <dl>
1743
1744 <dt id="ce---cuddled-else"><b>-ce</b>, <b>--cuddled-else</b></dt>
1745 <dd>
1746
1747 <p>Enable the &quot;cuddled else&quot; style, in which <code>else</code> and <code>elsif</code> are follow immediately after the curly brace closing the previous block. The default is not to use cuddled elses, and is indicated with the flag <b>-nce</b> or <b>--nocuddled-else</b>. Here is a comparison of the alternatives:</p>
1748
1749 <pre><code>  # -ce
1750   if ($task) {
1751       yyy();
1752   } else {
1753       zzz();
1754   }
1755
1756   # -nce (default)
1757   if ($task) {
1758         yyy();
1759   }
1760   else {
1761         zzz();
1762   }</code></pre>
1763
1764 <p>In this example the keyword <b>else</b> is placed on the same line which begins with the preceding closing block brace and is followed by its own opening block brace on the same line. Other keywords and function names which are formatted with this &quot;cuddled&quot; style are <b>elsif</b>, <b>continue</b>, <b>catch</b>, <b>finally</b>.</p>
1765
1766 <p>Other block types can be formatted by specifying their names on a separate parameter <b>-cbl</b>, described in a later section.</p>
1767
1768 <p>Cuddling between a pair of code blocks requires that the closing brace of the first block start a new line. If this block is entirely on one line in the input file, it is necessary to decide if it should be broken to allow cuddling. This decision is controlled by the flag <b>-cbo=n</b> discussed below. The default and recommended value of <b>-cbo=1</b> bases this decision on the first block in the chain. If it spans multiple lines then cuddling is made and continues along the chain, regardless of the sizes of subsequent blocks. Otherwise, short lines remain intact.</p>
1769
1770 <p>So for example, the <b>-ce</b> flag would not have any effect if the above snippet is rewritten as</p>
1771
1772 <pre><code>  if ($task) { yyy() }
1773   else {    zzz() }</code></pre>
1774
1775 <p>If the first block spans multiple lines, then cuddling can be done and will continue for the subsequent blocks in the chain, as illustrated in the previous snippet.</p>
1776
1777 <p>If there are blank lines between cuddled blocks they will be eliminated. If there are comments after the closing brace where cuddling would occur then cuddling will be prevented. If this occurs, cuddling will restart later in the chain if possible.</p>
1778
1779 </dd>
1780 <dt id="cb---cuddled-blocks"><b>-cb</b>, <b>--cuddled-blocks</b></dt>
1781 <dd>
1782
1783 <p>This flag is equivalent to <b>-ce</b>.</p>
1784
1785 </dd>
1786 <dt id="cbl---cuddled-block-list"><b>-cbl</b>, <b>--cuddled-block-list</b></dt>
1787 <dd>
1788
1789 <p>The built-in default cuddled block types are <b>else, elsif, continue, catch, finally</b>.</p>
1790
1791 <p>Additional block types to which the <b>-cuddled-blocks</b> style applies can be defined by this parameter. This parameter is a character string, giving a list of block types separated by commas or spaces. For example, to cuddle code blocks of type sort, map and grep, in addition to the default types, the string could be set to</p>
1792
1793 <pre><code>  -cbl=&quot;sort map grep&quot;</code></pre>
1794
1795 <p>or equivalently</p>
1796
1797 <pre><code>  -cbl=sort,map,grep</code></pre>
1798
1799 <p>Note however that these particular block types are typically short so there might not be much opportunity for the cuddled format style.</p>
1800
1801 <p>Using commas avoids the need to protect spaces with quotes.</p>
1802
1803 <p>As a diagnostic check, the flag <b>--dump-cuddled-block-list</b> or <b>-dcbl</b> can be used to view the hash of values that are generated by this flag.</p>
1804
1805 <p>Finally, note that the <b>-cbl</b> flag by itself merely specifies which blocks are formatted with the cuddled format. It has no effect unless this formatting style is activated with <b>-ce</b>.</p>
1806
1807 </dd>
1808 <dt id="cblx---cuddled-block-list-exclusive"><b>-cblx</b>, <b>--cuddled-block-list-exclusive</b></dt>
1809 <dd>
1810
1811 <p>When cuddled else formatting is selected with <b>-ce</b>, setting this flag causes perltidy to ignore its built-in defaults and rely exclusively on the block types specified on the <b>-cbl</b> flag described in the previous section. For example, to avoid using cuddled <b>catch</b> and <b>finally</b>, which are among the defaults, the following set of parameters could be used:</p>
1812
1813 <pre><code>  perltidy -ce -cbl=&#39;else elsif continue&#39; -cblx</code></pre>
1814
1815 </dd>
1816 <dt id="cbo-n---cuddled-break-option-n"><b>-cbo=n</b>, <b>--cuddled-break-option=n</b></dt>
1817 <dd>
1818
1819 <p>Cuddled formatting is only possible between a pair of code blocks if the closing brace of the first block starts a new line. If a block is encountered which is entirely on a single line, and cuddled formatting is selected, it is necessary to make a decision as to whether or not to &quot;break&quot; the block, meaning to cause it to span multiple lines. This parameter controls that decision. The options are:</p>
1820
1821 <pre><code>   cbo=0  Never force a short block to break.
1822    cbo=1  If the first of a pair of blocks is broken in the input file,
1823           then break the second [DEFAULT].
1824    cbo=2  Break open all blocks for maximal cuddled formatting.</code></pre>
1825
1826 <p>The default and recommended value is <b>cbo=1</b>. With this value, if the starting block of a chain spans multiple lines, then a cascade of breaks will occur for remaining blocks causing the entire chain to be cuddled.</p>
1827
1828 <p>The option <b>cbo=0</b> can produce erratic cuddling if there are numerous one-line blocks.</p>
1829
1830 <p>The option <b>cbo=2</b> produces maximal cuddling but will not allow any short blocks.</p>
1831
1832 </dd>
1833 <dt id="bl---opening-brace-on-new-line-or---brace-left"><b>-bl</b>, <b>--opening-brace-on-new-line</b>, or <b>--brace-left</b></dt>
1834 <dd>
1835
1836 <p>Use the flag <b>-bl</b> to place an opening block brace on a new line:</p>
1837
1838 <pre><code>  if ( $input_file eq &#39;-&#39; )
1839   {
1840       ...
1841   }</code></pre>
1842
1843 <p>By default it applies to all structural blocks except <b>sort map grep eval</b> and anonymous subs.</p>
1844
1845 <p>The default is <b>-nbl</b> which places an opening brace on the same line as the keyword introducing it if possible. For example,</p>
1846
1847 <pre><code>  # default
1848   if ( $input_file eq &#39;-&#39; ) {
1849      ...
1850   }</code></pre>
1851
1852 <p>When <b>-bl</b> is set, the blocks to which this applies can be controlled with the parameters <b>--brace-left-list</b> and <b>-brace-left-exclusion-list</b> described in the next sections.</p>
1853
1854 </dd>
1855 <dt id="bll-s---brace-left-list-s"><b>-bll=s</b>, <b>--brace-left-list=s</b></dt>
1856 <dd>
1857
1858 <p>Use this parameter to change the types of block braces for which the <b>-bl</b> flag applies; see <a href="#Specifying-Block-Types">&quot;Specifying Block Types&quot;</a>. For example, <b>-bll=&#39;if elsif else sub&#39;</b> would apply it to only <code>if/elsif/else</code> and named sub blocks. The default is all blocks, <b>-bll=&#39;*&#39;</b>.</p>
1859
1860 </dd>
1861 <dt id="blxl-s---brace-left-exclusion-list-s"><b>-blxl=s</b>, <b>--brace-left-exclusion-list=s</b></dt>
1862 <dd>
1863
1864 <p>Use this parameter to exclude types of block braces for which the <b>-bl</b> flag applies; see <a href="#Specifying-Block-Types">&quot;Specifying Block Types&quot;</a>. For example, the default settings <b>-bll=&#39;*&#39;</b> and <b>-blxl=&#39;sort map grep eval asub&#39;</b> mean all blocks except <b>sort map grep eval</b> and anonymous sub blocks.</p>
1865
1866 <p>Note that the lists <b>-bll=s</b> and <b>-blxl=s</b> control the behavior of the <b>-bl</b> flag but have no effect unless the <b>-bl</b> flag is set.</p>
1867
1868 </dd>
1869 <dt id="sbl---opening-sub-brace-on-new-line"><b>-sbl</b>, <b>--opening-sub-brace-on-new-line</b></dt>
1870 <dd>
1871
1872 <p>The flag <b>-sbl</b> provides a shortcut way to turn on <b>-bl</b> just for named subs. The same effect can be achieved by turning on <b>-bl</b> with the block list set as <b>-bll=&#39;sub&#39;</b>.</p>
1873
1874 <p>For example,</p>
1875
1876 <pre><code> perltidy -sbl</code></pre>
1877
1878 <p>produces this result:</p>
1879
1880 <pre><code> sub message
1881  {
1882     if (!defined($_[0])) {
1883         print(&quot;Hello, World\n&quot;);
1884     }
1885     else {
1886         print($_[0], &quot;\n&quot;);
1887     }
1888  }</code></pre>
1889
1890 <p>This flag is negated with <b>-nsbl</b>, which is the default.</p>
1891
1892 </dd>
1893 <dt id="asbl---opening-anonymous-sub-brace-on-new-line"><b>-asbl</b>, <b>--opening-anonymous-sub-brace-on-new-line</b></dt>
1894 <dd>
1895
1896 <p>The flag <b>-asbl</b> is like the <b>-sbl</b> flag except that it applies to anonymous sub&#39;s instead of named subs. For example</p>
1897
1898 <pre><code> perltidy -asbl</code></pre>
1899
1900 <p>produces this result:</p>
1901
1902 <pre><code> $a = sub
1903  {
1904      if ( !defined( $_[0] ) ) {
1905          print(&quot;Hello, World\n&quot;);
1906      }
1907      else {
1908          print( $_[0], &quot;\n&quot; );
1909      }
1910  };</code></pre>
1911
1912 <p>This flag is negated with <b>-nasbl</b>, and the default is <b>-nasbl</b>.</p>
1913
1914 </dd>
1915 <dt id="bli---brace-left-and-indent"><b>-bli</b>, <b>--brace-left-and-indent</b></dt>
1916 <dd>
1917
1918 <p>The flag <b>-bli</b> is similar to the <b>-bl</b> flag but in addition it causes one unit of continuation indentation ( see <b>-ci</b> ) to be placed before an opening and closing block braces.</p>
1919
1920 <p>For example, perltidy -bli gives</p>
1921
1922 <pre><code>        if ( $input_file eq &#39;-&#39; )
1923           {
1924             important_function();
1925           }</code></pre>
1926
1927 <p>By default, this extra indentation occurs for block types: <b>if</b>, <b>elsif</b>, <b>else</b>, <b>unless</b>, <b>while</b>, <b>for</b>, <b>foreach</b>, <b>do</b>, and also <b>named subs</b> and blocks preceded by a <b>label</b>. The next item shows how to change this.</p>
1928
1929 <p><b>Note</b>: The <b>-bli</b> flag is similar to the <b>-bl</b> flag, with the difference being that braces get indented. But these two flags are implemented independently, and have different default settings for historical reasons. If desired, a mixture of effects can be achieved if desired by turning them both on with different <b>-list</b> settings. In the event that both settings are selected for a certain block type, the <b>-bli</b> style has priority.</p>
1930
1931 </dd>
1932 <dt id="blil-s---brace-left-and-indent-list-s"><b>-blil=s</b>, <b>--brace-left-and-indent-list=s</b></dt>
1933 <dd>
1934
1935 <p>Use this parameter to change the types of block braces for which the <b>-bli</b> flag applies; see <a href="#Specifying-Block-Types">&quot;Specifying Block Types&quot;</a>.</p>
1936
1937 <p>The default is <b>-blil=&#39;if else elsif unless while for foreach do : sub&#39;</b>.</p>
1938
1939 </dd>
1940 <dt id="blixl-s---brace-left-and-indent-exclusion-list-s"><b>-blixl=s</b>, <b>--brace-left-and-indent-exclusion-list=s</b></dt>
1941 <dd>
1942
1943 <p>Use this parameter to exclude types of block braces for which the <b>-bli</b> flag applies; see <a href="#Specifying-Block-Types">&quot;Specifying Block Types&quot;</a>.</p>
1944
1945 <p>This might be useful in conjunction with selecting all blocks <b>-blil=&#39;*&#39;</b>. The default setting is <b>-blixl=&#39; &#39;</b>, which does not exclude any blocks.</p>
1946
1947 <p>Note that the two parameters <b>-blil</b> and <b>-blixl</b> control the behavior of the <b>-bli</b> flag but have no effect unless the <b>-bli</b> flag is set.</p>
1948
1949 </dd>
1950 <dt id="bar---opening-brace-always-on-right"><b>-bar</b>, <b>--opening-brace-always-on-right</b></dt>
1951 <dd>
1952
1953 <p>The default style, <b>-nbl</b> places the opening code block brace on a new line if it does not fit on the same line as the opening keyword, like this:</p>
1954
1955 <pre><code>        if ( $bigwasteofspace1 &amp;&amp; $bigwasteofspace2
1956           || $bigwasteofspace3 &amp;&amp; $bigwasteofspace4 )
1957         {
1958             big_waste_of_time();
1959         }</code></pre>
1960
1961 <p>To force the opening brace to always be on the right, use the <b>-bar</b> flag. In this case, the above example becomes</p>
1962
1963 <pre><code>        if ( $bigwasteofspace1 &amp;&amp; $bigwasteofspace2
1964           || $bigwasteofspace3 &amp;&amp; $bigwasteofspace4 ) {
1965             big_waste_of_time();
1966         }</code></pre>
1967
1968 <p>A conflict occurs if both <b>-bl</b> and <b>-bar</b> are specified.</p>
1969
1970 </dd>
1971 <dt id="otr---opening-token-right-and-related-flags"><b>-otr</b>, <b>--opening-token-right</b> and related flags</dt>
1972 <dd>
1973
1974 <p>The <b>-otr</b> flag is a hint that perltidy should not place a break between a comma and an opening token. For example:</p>
1975
1976 <pre><code>    # default formatting
1977     push @{ $self-&gt;{$module}{$key} },
1978       {
1979         accno       =&gt; $ref-&gt;{accno},
1980         description =&gt; $ref-&gt;{description}
1981       };
1982
1983     # perltidy -otr
1984     push @{ $self-&gt;{$module}{$key} }, {
1985         accno       =&gt; $ref-&gt;{accno},
1986         description =&gt; $ref-&gt;{description}
1987       };</code></pre>
1988
1989 <p>The flag <b>-otr</b> is actually an abbreviation for three other flags which can be used to control parens, hash braces, and square brackets separately if desired:</p>
1990
1991 <pre><code>  -opr  or --opening-paren-right
1992   -ohbr or --opening-hash-brace-right
1993   -osbr or --opening-square-bracket-right</code></pre>
1994
1995 </dd>
1996 <dt id="bbhb-n---break-before-hash-brace-n-and-related-flags"><b>-bbhb=n</b>, <b>--break-before-hash-brace=n</b> and related flags</dt>
1997 <dd>
1998
1999 <p>When a list of items spans multiple lines, the default formatting is to place the opening brace (or other container token) at the end of the starting line, like this:</p>
2000
2001 <pre><code>    $romanNumerals = {
2002         one   =&gt; &#39;I&#39;,
2003         two   =&gt; &#39;II&#39;,
2004         three =&gt; &#39;III&#39;,
2005         four  =&gt; &#39;IV&#39;,
2006     };</code></pre>
2007
2008 <p>This flag can change the default behavior to cause a line break to be placed before the opening brace according to the value given to the integer <b>n</b>:</p>
2009
2010 <pre><code>  -bbhb=0 never break [default]
2011   -bbhb=1 stable: break if the input script had a break
2012   -bbhb=2 break if list is &#39;complex&#39; (see note below)
2013   -bbhb=3 always break</code></pre>
2014
2015 <p>For example,</p>
2016
2017 <pre><code>    # perltidy -bbhb=3
2018     $romanNumerals =
2019       {
2020         one   =&gt; &#39;I&#39;,
2021         two   =&gt; &#39;II&#39;,
2022         three =&gt; &#39;III&#39;,
2023         four  =&gt; &#39;IV&#39;,
2024       };</code></pre>
2025
2026 <p>There are several points to note about this flag:</p>
2027
2028 <ul>
2029
2030 <li><p>This parameter only applies if the opening brace is preceded by an &#39;=&#39; or &#39;=&gt;&#39;.</p>
2031
2032 </li>
2033 <li><p>This parameter only applies if the contents of the container looks like a list. The contents need to contain some commas or &#39;=&gt;&#39;s at the next interior level to be considered a list.</p>
2034
2035 </li>
2036 <li><p>For the <b>n=2</b> option, a list is considered &#39;complex&#39; if it is part of a nested list structure which spans multiple lines in the input file.</p>
2037
2038 </li>
2039 <li><p>If multiple opening tokens have been &#39;welded&#39; together with the <b>-wn</b> parameter, then this parameter has no effect.</p>
2040
2041 </li>
2042 <li><p>The indentation of the braces will normally be one level of continuation indentation by default. This can be changed with the parameter <b>-bbhbi=n</b> in the next section.</p>
2043
2044 </li>
2045 <li><p>Similar flags for controlling parens and square brackets are given in the subsequent section.</p>
2046
2047 </li>
2048 </ul>
2049
2050 </dd>
2051 <dt id="bbhbi-n---break-before-hash-brace-and-indent-n"><b>-bbhbi=n</b>, <b>--break-before-hash-brace-and-indent=n</b></dt>
2052 <dd>
2053
2054 <p>This flag is a companion to <b>-bbhb=n</b> for controlling the indentation of an opening hash brace which is placed on a new line by that parameter. The indentation is as follows:</p>
2055
2056 <pre><code>  -bbhbi=0 one continuation level [default]
2057   -bbhbi=1 outdent by one continuation level
2058   -bbhbi=2 indent one full indentation level</code></pre>
2059
2060 <p>For example:</p>
2061
2062 <pre><code>    # perltidy -bbhb=3 -bbhbi=1
2063     $romanNumerals =
2064     {
2065         one   =&gt; &#39;I&#39;,
2066         two   =&gt; &#39;II&#39;,
2067         three =&gt; &#39;III&#39;,
2068         four  =&gt; &#39;IV&#39;,
2069     };
2070
2071     # perltidy -bbhb=3 -bbhbi=2
2072     $romanNumerals =
2073         {
2074         one   =&gt; &#39;I&#39;,
2075         two   =&gt; &#39;II&#39;,
2076         three =&gt; &#39;III&#39;,
2077         four  =&gt; &#39;IV&#39;,
2078         };</code></pre>
2079
2080 <p>Note that this parameter has no effect unless <b>-bbhb=n</b> is also set.</p>
2081
2082 </dd>
2083 <dt id="bbsb-n---break-before-square-bracket-n"><b>-bbsb=n</b>, <b>--break-before-square-bracket=n</b></dt>
2084 <dd>
2085
2086 <p>This flag is similar to the flag described above, except it applies to lists contained within square brackets.</p>
2087
2088 <pre><code>  -bbsb=0 never break [default]
2089   -bbsb=1 stable: break if the input script had a break
2090   -bbsb=2 break if list is &#39;complex&#39; (part of nested list structure)
2091   -bbsb=3 always break</code></pre>
2092
2093 </dd>
2094 <dt id="bbsbi-n---break-before-square-bracket-and-indent-n"><b>-bbsbi=n</b>, <b>--break-before-square-bracket-and-indent=n</b></dt>
2095 <dd>
2096
2097 <p>This flag is a companion to <b>-bbsb=n</b> for controlling the indentation of an opening square bracket which is placed on a new line by that parameter. The indentation is as follows:</p>
2098
2099 <pre><code>  -bbsbi=0 one continuation level [default]
2100   -bbsbi=1 outdent by one continuation level
2101   -bbsbi=2 indent one full indentation level</code></pre>
2102
2103 </dd>
2104 <dt id="bbp-n---break-before-paren-n"><b>-bbp=n</b>, <b>--break-before-paren=n</b></dt>
2105 <dd>
2106
2107 <p>This flag is similar to <b>-bbhb=n</b>, described above, except it applies to lists contained within parens.</p>
2108
2109 <pre><code>  -bbp=0 never break [default]
2110   -bbp=1 stable: break if the input script had a break
2111   -bpb=2 break if list is &#39;complex&#39; (part of nested list structure)
2112   -bbp=3 always break</code></pre>
2113
2114 </dd>
2115 <dt id="bbpi-n---break-before-paren-and-indent-n"><b>-bbpi=n</b>, <b>--break-before-paren-and-indent=n</b></dt>
2116 <dd>
2117
2118 <p>This flag is a companion to <b>-bbp=n</b> for controlling the indentation of an opening paren which is placed on a new line by that parameter. The indentation is as follows:</p>
2119
2120 <pre><code>  -bbpi=0 one continuation level [default]
2121   -bbpi=1 outdent by one continuation level
2122   -bbpi=2 indent one full indentation level</code></pre>
2123
2124 </dd>
2125 </dl>
2126
2127 <h2 id="Welding">Welding</h2>
2128
2129 <dl>
2130
2131 <dt id="wn---weld-nested-containers"><b>-wn</b>, <b>--weld-nested-containers</b></dt>
2132 <dd>
2133
2134 <p>The <b>-wn</b> flag causes closely nested pairs of opening and closing container symbols (curly braces, brackets, or parens) to be &quot;welded&quot; together, meaning that they are treated as if combined into a single unit, with the indentation of the innermost code reduced to be as if there were just a single container symbol.</p>
2135
2136 <p>For example:</p>
2137
2138 <pre><code>        # default formatting
2139         do {
2140             {
2141                 next if $x == $y;
2142             }
2143         } until $x++ &gt; $z;
2144
2145         # perltidy -wn
2146         do { {
2147             next if $x == $y;
2148         } } until $x++ &gt; $z;</code></pre>
2149
2150 <p>When this flag is set perltidy makes a preliminary pass through the file and identifies all nested pairs of containers. To qualify as a nested pair, the closing container symbols must be immediately adjacent and the opening symbols must either (1) be adjacent as in the above example, or (2) have an anonymous sub declaration following an outer opening container symbol which is not a code block brace, or (3) have an outer opening paren separated from the inner opening symbol by any single non-container symbol or something that looks like a function evaluation, as illustrated in the next examples. An additional option (4) which can be turned on with the flag <b>--weld-fat-comma</b> is when the opening container symbols are separated by a hash key and fat comma (=&gt;).</p>
2151
2152 <p>Any container symbol may serve as both the inner container of one pair and as the outer container of an adjacent pair. Consequently, any number of adjacent opening or closing symbols may join together in weld. For example, here are three levels of wrapped function calls:</p>
2153
2154 <pre><code>        # default formatting
2155         my (@date_time) = Localtime(
2156             Date_to_Time(
2157                 Add_Delta_DHMS(
2158                     $year, $month,  $day, $hour, $minute, $second,
2159                     &#39;0&#39;,   $offset, &#39;0&#39;,  &#39;0&#39;
2160                 )
2161             )
2162         );
2163
2164         # perltidy -wn
2165         my (@date_time) = Localtime( Date_to_Time( Add_Delta_DHMS(
2166             $year, $month,  $day, $hour, $minute, $second,
2167             &#39;0&#39;,   $offset, &#39;0&#39;,  &#39;0&#39;
2168         ) ) );</code></pre>
2169
2170 <p>Notice how the indentation of the inner lines are reduced by two levels in this case. This example also shows the typical result of this formatting, namely it is a sandwich consisting of an initial opening layer, a central section of any complexity forming the &quot;meat&quot; of the sandwich, and a final closing layer. This predictable structure helps keep the compacted structure readable.</p>
2171
2172 <p>The inner sandwich layer is required to be at least one line thick. If this cannot be achieved, welding does not occur. This constraint can cause formatting to take a couple of iterations to stabilize when it is first applied to a script. The <b>-conv</b> flag can be used to insure that the final format is achieved in a single run.</p>
2173
2174 <p>Here is an example illustrating a welded container within a welded containers:</p>
2175
2176 <pre><code>        # default formatting
2177         $x-&gt;badd(
2178             bmul(
2179                 $class-&gt;new(
2180                     abs(
2181                         $sx * int( $xr-&gt;numify() ) &amp; $sy * int( $yr-&gt;numify() )
2182                     )
2183                 ),
2184                 $m
2185             )
2186         );
2187
2188         # perltidy -wn
2189         $x-&gt;badd( bmul(
2190             $class-&gt;new( abs(
2191                 $sx * int( $xr-&gt;numify() ) &amp; $sy * int( $yr-&gt;numify() )
2192             ) ),
2193             $m
2194         ) );</code></pre>
2195
2196 <p>The welded closing tokens are by default on a separate line but this can be modified with the <b>-vtc=n</b> flag (described in the next section). For example, the same example adding <b>-vtc=2</b> is</p>
2197
2198 <pre><code>        # perltidy -wn -vtc=2
2199         $x-&gt;badd( bmul(
2200             $class-&gt;new( abs(
2201                 $sx * int( $xr-&gt;numify() ) &amp; $sy * int( $yr-&gt;numify() ) ) ),
2202             $m ) );</code></pre>
2203
2204 <p>This format option is quite general but there are some limitations.</p>
2205
2206 <p>One limitation is that any line length limit still applies and can cause long welded sections to be broken into multiple lines.</p>
2207
2208 <p>Another limitation is that an opening symbol which delimits quoted text cannot be included in a welded pair. This is because quote delimiters are treated specially in perltidy.</p>
2209
2210 <p>Finally, the stacking of containers defined by this flag have priority over any other container stacking flags. This is because any welding is done first.</p>
2211
2212 </dd>
2213 <dt id="wfc---weld-fat-comma"><b>-wfc</b>, <b>--weld-fat-comma </b></dt>
2214 <dd>
2215
2216 <p>When the <b>-wfc</b> flag is set, along with <b>-wn</b>, perltidy is allowed to weld an opening paren to an inner opening container when they are separated by a hash key and fat comma (=&gt;). for example</p>
2217
2218 <pre><code>    # perltidy -wn -wfc
2219     elf-&gt;call_method( method_name_foo =&gt; {
2220         some_arg1       =&gt; $foo,
2221         some_other_arg3 =&gt; $bar-&gt;{&#39;baz&#39;},
2222     } );</code></pre>
2223
2224 <p>This option is off by default.</p>
2225
2226 </dd>
2227 <dt id="wnxl-s---weld-nested-exclusion-list"><b>-wnxl=s</b>, <b>--weld-nested-exclusion-list</b></dt>
2228 <dd>
2229
2230 <p>The <b>-wnxl=s</b> flag provides some control over the types of containers which can be welded. The <b>-wn</b> flag by default is &quot;greedy&quot; in welding adjacent containers. If it welds more types of containers than desired, this flag provides a capability to reduce the amount of welding by specifying a list of things which should <b>not</b> be welded.</p>
2231
2232 <p>The logic in perltidy to apply this is straightforward. As each container token is being considered for joining a weld, any exclusion rules are consulted and used to reject the weld if necessary.</p>
2233
2234 <p>This list is a string with space-separated items. Each item consists of up to three pieces of information: (1) an optional position, (2) an optional preceding type, and (3) a container type.</p>
2235
2236 <p>The only required piece of information is a container type, which is one of &#39;(&#39;, &#39;[&#39;, &#39;{&#39; or &#39;q&#39;. The first three of these are container tokens and the last represents a quoted list. For example the string</p>
2237
2238 <pre><code>  -wnxl=&#39;[ { q&#39;</code></pre>
2239
2240 <p>means do <b>NOT</b> include square-brackets, braces, or quotes in any welds. The only unspecified container is &#39;(&#39;, so this string means that only welds involving parens will be made.</p>
2241
2242 <p>To illustrate, following welded snippet consists of a chain of three welded containers with types &#39;(&#39; &#39;[&#39; and &#39;q&#39;:</p>
2243
2244 <pre><code>    # perltidy -wn
2245     skip_symbols( [ qw(
2246         Perl_dump_fds
2247         Perl_ErrorNo
2248         Perl_GetVars
2249         PL_sys_intern
2250     ) ] );</code></pre>
2251
2252 <p>Even though the qw term uses parens as the quote delimiter, it has a special type &#39;q&#39; here. If it appears in a weld it always appears at the end of the welded chain.</p>
2253
2254 <p>Any of the container types &#39;[&#39;, &#39;{&#39;, and &#39;(&#39; may be prefixed with a position indicator which is either &#39;^&#39;, to indicate the first token of a welded sequence, or &#39;.&#39;, to indicate an interior token of a welded sequence. (Since a quoted string &#39;q&#39; always ends a chain it does need a position indicator).</p>
2255
2256 <p>For example, if we do not want a sequence of welded containers to start with a square bracket we could use</p>
2257
2258 <pre><code>  -wnxl=&#39;^[&#39;</code></pre>
2259
2260 <p>In the above snippet, there is a square bracket but it does not start the chain, so the formatting would be unchanged if it were formatted with this restriction.</p>
2261
2262 <p>A third optional item of information which can be given is an alphanumeric letter which is used to limit the selection further depending on the type of token immediately before the container. If given, it goes just before the container symbol. The possible letters are currently &#39;k&#39;, &#39;K&#39;, &#39;f&#39;, &#39;F&#39;, &#39;w&#39;, and &#39;W&#39;, with these meanings:</p>
2263
2264 <pre><code> &#39;k&#39; matches if the previous nonblank token is a perl built-in keyword (such as &#39;if&#39;, &#39;while&#39;),
2265  &#39;K&#39; matches if &#39;k&#39; does not, meaning that the previous token is not a keyword.
2266  &#39;f&#39; matches if the previous token is a function other than a keyword.
2267  &#39;F&#39; matches if &#39;f&#39; does not.
2268  &#39;w&#39; matches if either &#39;k&#39; or &#39;f&#39; match.
2269  &#39;W&#39; matches if &#39;w&#39; does not.</code></pre>
2270
2271 <p>For example, compare</p>
2272
2273 <pre><code>        # perltidy -wn
2274         if ( defined( $_Cgi_Query{
2275             $Config{&#39;methods&#39;}{&#39;authentication&#39;}{&#39;remote&#39;}{&#39;cgi&#39;}{&#39;username&#39;}
2276         } ) )</code></pre>
2277
2278 <p>with</p>
2279
2280 <pre><code>        # perltidy -wn -wnxl=&#39;^K( {&#39;
2281         if ( defined(
2282             $_Cgi_Query{ $Config{&#39;methods&#39;}{&#39;authentication&#39;}{&#39;remote&#39;}{&#39;cgi&#39;}
2283                   {&#39;username&#39;} }
2284         ) )</code></pre>
2285
2286 <p>The first case does maximum welding. In the second case the leading paren is retained by the rule (it would have been rejected if preceded by a non-keyword) but the curly brace is rejected by the rule.</p>
2287
2288 <p>Here are some additional example strings and their meanings:</p>
2289
2290 <pre><code>    &#39;^(&#39;   - the weld must not start with a paren
2291     &#39;.(&#39;   - the second and later tokens may not be parens
2292     &#39;.w(&#39;  - the second and later tokens may not keyword or function call parens
2293     &#39;(&#39;    - no parens in a weld
2294     &#39;^K(&#39;  - exclude a leading paren preceded by a non-keyword
2295     &#39;.k(&#39;  - exclude a secondary paren preceded by a keyword
2296     &#39;[ {&#39;  - exclude all brackets and braces
2297     &#39;[ ( ^K{&#39; - exclude everything except nested structures like do {{  ... }}</code></pre>
2298
2299 </dd>
2300 <dt id="Vertical-tightness-of-non-block-curly-braces-parentheses-and-square-brackets"><b>Vertical tightness</b> of non-block curly braces, parentheses, and square brackets.</dt>
2301 <dd>
2302
2303 <p>These parameters control what shall be called vertical tightness. Here are the main points:</p>
2304
2305 <ul>
2306
2307 <li><p>Opening tokens (except for block braces) are controlled by <b>-vt=n</b>, or <b>--vertical-tightness=n</b>, where</p>
2308
2309 <pre><code> -vt=0 always break a line after opening token (default).
2310  -vt=1 do not break unless this would produce more than one
2311          step in indentation in a line.
2312  -vt=2 never break a line after opening token</code></pre>
2313
2314 </li>
2315 <li><p>You must also use the <b>-lp</b> flag when you use the <b>-vt</b> flag; the reason is explained below.</p>
2316
2317 </li>
2318 <li><p>Closing tokens (except for block braces) are controlled by <b>-vtc=n</b>, or <b>--vertical-tightness-closing=n</b>, where</p>
2319
2320 <pre><code> -vtc=0 always break a line before a closing token (default),
2321  -vtc=1 do not break before a closing token which is followed
2322         by a semicolon or another closing token, and is not in
2323         a list environment.
2324  -vtc=2 never break before a closing token.
2325  -vtc=3 Like -vtc=1 except always break before a closing token
2326         if the corresponding opening token follows an = or =&gt;.</code></pre>
2327
2328 <p>The rules for <b>-vtc=1</b> and <b>-vtc=3</b> are designed to maintain a reasonable balance between tightness and readability in complex lists.</p>
2329
2330 </li>
2331 <li><p>Different controls may be applied to different token types, and it is also possible to control block braces; see below.</p>
2332
2333 </li>
2334 <li><p>Finally, please note that these vertical tightness flags are merely hints to the formatter, and it cannot always follow them. Things which make it difficult or impossible include comments, blank lines, blocks of code within a list, and possibly the lack of the <b>-lp</b> parameter. Also, these flags may be ignored for very small lists (2 or 3 lines in length).</p>
2335
2336 </li>
2337 </ul>
2338
2339 <p>Here are some examples:</p>
2340
2341 <pre><code>    # perltidy -lp -vt=0 -vtc=0
2342     %romanNumerals = (
2343                        one   =&gt; &#39;I&#39;,
2344                        two   =&gt; &#39;II&#39;,
2345                        three =&gt; &#39;III&#39;,
2346                        four  =&gt; &#39;IV&#39;,
2347     );
2348
2349     # perltidy -lp -vt=1 -vtc=0
2350     %romanNumerals = ( one   =&gt; &#39;I&#39;,
2351                        two   =&gt; &#39;II&#39;,
2352                        three =&gt; &#39;III&#39;,
2353                        four  =&gt; &#39;IV&#39;,
2354     );
2355
2356     # perltidy -lp -vt=1 -vtc=1
2357     %romanNumerals = ( one   =&gt; &#39;I&#39;,
2358                        two   =&gt; &#39;II&#39;,
2359                        three =&gt; &#39;III&#39;,
2360                        four  =&gt; &#39;IV&#39;, );
2361
2362     # perltidy -vtc=3
2363     my_function(
2364         one   =&gt; &#39;I&#39;,
2365         two   =&gt; &#39;II&#39;,
2366         three =&gt; &#39;III&#39;,
2367         four  =&gt; &#39;IV&#39;, );
2368
2369     # perltidy -vtc=3
2370     %romanNumerals = (
2371         one   =&gt; &#39;I&#39;,
2372         two   =&gt; &#39;II&#39;,
2373         three =&gt; &#39;III&#39;,
2374         four  =&gt; &#39;IV&#39;,
2375     );</code></pre>
2376
2377 <p>In the last example for <b>-vtc=3</b>, the opening paren is preceded by an equals so the closing paren is placed on a new line.</p>
2378
2379 <p>The difference between <b>-vt=1</b> and <b>-vt=2</b> is shown here:</p>
2380
2381 <pre><code>    # perltidy -lp -vt=1
2382     $init-&gt;add(
2383                 mysprintf( &quot;(void)find_threadsv(%s);&quot;,
2384                            cstring( $threadsv_names[ $op-&gt;targ ] )
2385                 )
2386     );
2387
2388     # perltidy -lp -vt=2
2389     $init-&gt;add( mysprintf( &quot;(void)find_threadsv(%s);&quot;,
2390                            cstring( $threadsv_names[ $op-&gt;targ ] )
2391                 )
2392     );</code></pre>
2393
2394 <p>With <b>-vt=1</b>, the line ending in <code>add(</code> does not combine with the next line because the next line is not balanced. This can help with readability, but <b>-vt=2</b> can be used to ignore this rule.</p>
2395
2396 <p>The tightest, and least readable, code is produced with both <code>-vt=2</code> and <code>-vtc=2</code>:</p>
2397
2398 <pre><code>    # perltidy -lp -vt=2 -vtc=2
2399     $init-&gt;add( mysprintf( &quot;(void)find_threadsv(%s);&quot;,
2400                            cstring( $threadsv_names[ $op-&gt;targ ] ) ) );</code></pre>
2401
2402 <p>Notice how the code in all of these examples collapses vertically as <b>-vt</b> increases, but the indentation remains unchanged. This is because perltidy implements the <b>-vt</b> parameter by first formatting as if <b>-vt=0</b>, and then simply overwriting one output line on top of the next, if possible, to achieve the desired vertical tightness. The <b>-lp</b> indentation style has been designed to allow this vertical collapse to occur, which is why it is required for the <b>-vt</b> parameter.</p>
2403
2404 <p>The <b>-vt=n</b> and <b>-vtc=n</b> parameters apply to each type of container token. If desired, vertical tightness controls can be applied independently to each of the closing container token types.</p>
2405
2406 <p>The parameters for controlling parentheses are <b>-pvt=n</b> or <b>--paren-vertical-tightness=n</b>, and <b>-pvtc=n</b> or <b>--paren-vertical-tightness-closing=n</b>.</p>
2407
2408 <p>Likewise, the parameters for square brackets are <b>-sbvt=n</b> or <b>--square-bracket-vertical-tightness=n</b>, and <b>-sbvtc=n</b> or <b>--square-bracket-vertical-tightness-closing=n</b>.</p>
2409
2410 <p>Finally, the parameters for controlling non-code block braces are <b>-bvt=n</b> or <b>--brace-vertical-tightness=n</b>, and <b>-bvtc=n</b> or <b>--brace-vertical-tightness-closing=n</b>.</p>
2411
2412 <p>In fact, the parameter <b>-vt=n</b> is actually just an abbreviation for <b>-pvt=n -bvt=n sbvt=n</b>, and likewise <b>-vtc=n</b> is an abbreviation for <b>-pvtc=n -bvtc=n -sbvtc=n</b>.</p>
2413
2414 </dd>
2415 <dt id="bbvt-n-or---block-brace-vertical-tightness-n"><b>-bbvt=n</b> or <b>--block-brace-vertical-tightness=n</b></dt>
2416 <dd>
2417
2418 <p>The <b>-bbvt=n</b> flag is just like the <b>-vt=n</b> flag but applies to opening code block braces.</p>
2419
2420 <pre><code> -bbvt=0 break after opening block brace (default).
2421  -bbvt=1 do not break unless this would produce more than one
2422          step in indentation in a line.
2423  -bbvt=2 do not break after opening block brace.</code></pre>
2424
2425 <p>It is necessary to also use either <b>-bl</b> or <b>-bli</b> for this to work, because, as with other vertical tightness controls, it is implemented by simply overwriting a line ending with an opening block brace with the subsequent line. For example:</p>
2426
2427 <pre><code>    # perltidy -bli -bbvt=0
2428     if ( open( FILE, &quot;&lt; $File&quot; ) )
2429       {
2430         while ( $File = &lt;FILE&gt; )
2431           {
2432             $In .= $File;
2433             $count++;
2434           }
2435         close(FILE);
2436       }
2437
2438     # perltidy -bli -bbvt=1
2439     if ( open( FILE, &quot;&lt; $File&quot; ) )
2440       { while ( $File = &lt;FILE&gt; )
2441           { $In .= $File;
2442             $count++;
2443           }
2444         close(FILE);
2445       }</code></pre>
2446
2447 <p>By default this applies to blocks associated with keywords <b>if</b>, <b>elsif</b>, <b>else</b>, <b>unless</b>, <b>for</b>, <b>foreach</b>, <b>sub</b>, <b>while</b>, <b>until</b>, and also with a preceding label. This can be changed with the parameter <b>-bbvtl=string</b>, or <b>--block-brace-vertical-tightness-list=string</b>, where <b>string</b> is a space-separated list of block types. For more information on the possible values of this string, see <a href="#Specifying-Block-Types">&quot;Specifying Block Types&quot;</a></p>
2448
2449 <p>For example, if we want to just apply this style to <code>if</code>, <code>elsif</code>, and <code>else</code> blocks, we could use <code>perltidy -bli -bbvt=1 -bbvtl=&#39;if elsif else&#39;</code>.</p>
2450
2451 <p>There is no vertical tightness control for closing block braces; with one exception they will be placed on separate lines. The exception is that a cascade of closing block braces may be stacked on a single line. See <b>-scbb</b>.</p>
2452
2453 </dd>
2454 <dt id="sot---stack-opening-tokens-and-related-flags"><b>-sot</b>, <b>--stack-opening-tokens</b> and related flags</dt>
2455 <dd>
2456
2457 <p>The <b>-sot</b> flag tells perltidy to &quot;stack&quot; opening tokens when possible to avoid lines with isolated opening tokens.</p>
2458
2459 <p>For example:</p>
2460
2461 <pre><code>    # default
2462     $opt_c = Text::CSV_XS-&gt;new(
2463         {
2464             binary       =&gt; 1,
2465             sep_char     =&gt; $opt_c,
2466             always_quote =&gt; 1,
2467         }
2468     );
2469
2470     # -sot
2471     $opt_c = Text::CSV_XS-&gt;new( {
2472             binary       =&gt; 1,
2473             sep_char     =&gt; $opt_c,
2474             always_quote =&gt; 1,
2475         }
2476     );</code></pre>
2477
2478 <p>For detailed control of individual closing tokens the following controls can be used:</p>
2479
2480 <pre><code>  -sop  or --stack-opening-paren
2481   -sohb or --stack-opening-hash-brace
2482   -sosb or --stack-opening-square-bracket
2483   -sobb or --stack-opening-block-brace</code></pre>
2484
2485 <p>The flag <b>-sot</b> is an abbreviation for <b>-sop -sohb -sosb</b>.</p>
2486
2487 <p>The flag <b>-sobb</b> is an abbreviation for <b>-bbvt=2 -bbvtl=&#39;*&#39;</b>. This will case a cascade of opening block braces to appear on a single line, although this an uncommon occurrence except in test scripts.</p>
2488
2489 </dd>
2490 <dt id="sct---stack-closing-tokens-and-related-flags"><b>-sct</b>, <b>--stack-closing-tokens</b> and related flags</dt>
2491 <dd>
2492
2493 <p>The <b>-sct</b> flag tells perltidy to &quot;stack&quot; closing tokens when possible to avoid lines with isolated closing tokens.</p>
2494
2495 <p>For example:</p>
2496
2497 <pre><code>    # default
2498     $opt_c = Text::CSV_XS-&gt;new(
2499         {
2500             binary       =&gt; 1,
2501             sep_char     =&gt; $opt_c,
2502             always_quote =&gt; 1,
2503         }
2504     );
2505
2506     # -sct
2507     $opt_c = Text::CSV_XS-&gt;new(
2508         {
2509             binary       =&gt; 1,
2510             sep_char     =&gt; $opt_c,
2511             always_quote =&gt; 1,
2512         } );</code></pre>
2513
2514 <p>The <b>-sct</b> flag is somewhat similar to the <b>-vtc</b> flags, and in some cases it can give a similar result. The difference is that the <b>-vtc</b> flags try to avoid lines with leading opening tokens by &quot;hiding&quot; them at the end of a previous line, whereas the <b>-sct</b> flag merely tries to reduce the number of lines with isolated closing tokens by stacking them but does not try to hide them. For example:</p>
2515
2516 <pre><code>    # -vtc=2
2517     $opt_c = Text::CSV_XS-&gt;new(
2518         {
2519             binary       =&gt; 1,
2520             sep_char     =&gt; $opt_c,
2521             always_quote =&gt; 1, } );</code></pre>
2522
2523 <p>For detailed control of the stacking of individual closing tokens the following controls can be used:</p>
2524
2525 <pre><code>  -scp  or --stack-closing-paren
2526   -schb or --stack-closing-hash-brace
2527   -scsb or --stack-closing-square-bracket
2528   -scbb or --stack-closing-block-brace</code></pre>
2529
2530 <p>The flag <b>-sct</b> is an abbreviation for stacking the non-block closing tokens, <b>-scp -schb -scsb</b>.</p>
2531
2532 <p>Stacking of closing block braces, <b>-scbb</b>, causes a cascade of isolated closing block braces to be combined into a single line as in the following example:</p>
2533
2534 <pre><code>    # -scbb:
2535     for $w1 (@w1) {
2536         for $w2 (@w2) {
2537             for $w3 (@w3) {
2538                 for $w4 (@w4) {
2539                     push( @lines, &quot;$w1 $w2 $w3 $w4\n&quot; );
2540                 } } } }</code></pre>
2541
2542 <p>To simplify input even further for the case in which both opening and closing non-block containers are stacked, the flag <b>-sac</b> or <b>--stack-all-containers</b> is an abbreviation for <b>-sot -sct</b>.</p>
2543
2544 <p>Please note that if both opening and closing tokens are to be stacked, then the newer flag <b>-weld-nested-containers</b> may be preferable because it insures that stacking is always done symmetrically. It also removes an extra level of unnecessary indentation within welded containers. It is able to do this because it works on formatting globally rather than locally, as the <b>-sot</b> and <b>-sct</b> flags do.</p>
2545
2546 </dd>
2547 </dl>
2548
2549 <h2 id="Breaking-Before-or-After-Operators">Breaking Before or After Operators</h2>
2550
2551 <p>Four command line parameters provide some control over whether a line break should be before or after specific token types. Two parameters give detailed control:</p>
2552
2553 <p><b>-wba=s</b> or <b>--want-break-after=s</b>, and</p>
2554
2555 <p><b>-wbb=s</b> or <b>--want-break-before=s</b>.</p>
2556
2557 <p>These parameters are each followed by a quoted string, <b>s</b>, containing a list of token types (separated only by spaces). No more than one of each of these parameters should be specified, because repeating a command-line parameter always overwrites the previous one before perltidy ever sees it.</p>
2558
2559 <p>By default, perltidy breaks <b>after</b> these token types: % + - * / x != == &gt;= &lt;= =~ !~ &lt; &gt; | &amp; = **= += *= &amp;= &lt;&lt;= &amp;&amp;= -= /= |= &gt;&gt;= ||= //= .= %= ^= x=</p>
2560
2561 <p>And perltidy breaks <b>before</b> these token types by default: . &lt;&lt; &gt;&gt; -&gt; &amp;&amp; || //</p>
2562
2563 <p>To illustrate, to cause a break after a concatenation operator, <code>&#39;.&#39;</code>, rather than before it, the command line would be</p>
2564
2565 <pre><code>  -wba=&quot;.&quot;</code></pre>
2566
2567 <p>As another example, the following command would cause a break before math operators <code>&#39;+&#39;</code>, <code>&#39;-&#39;</code>, <code>&#39;/&#39;</code>, and <code>&#39;*&#39;</code>:</p>
2568
2569 <pre><code>  -wbb=&quot;+ - / *&quot;</code></pre>
2570
2571 <p>These commands should work well for most of the token types that perltidy uses (use <b>--dump-token-types</b> for a list). Also try the <b>-D</b> flag on a short snippet of code and look at the .DEBUG file to see the tokenization. However, for a few token types there may be conflicts with hardwired logic which cause unexpected results. One example is curly braces, which should be controlled with the parameter <b>bl</b> provided for that purpose.</p>
2572
2573 <p><b>WARNING</b> Be sure to put these tokens in quotes to avoid having them misinterpreted by your command shell.</p>
2574
2575 <p>Two additional parameters are available which, though they provide no further capability, can simplify input are:</p>
2576
2577 <p><b>-baao</b> or <b>--break-after-all-operators</b>,</p>
2578
2579 <p><b>-bbao</b> or <b>--break-before-all-operators</b>.</p>
2580
2581 <p>The -baao sets the default to be to break after all of the following operators:</p>
2582
2583 <pre><code>    % + - * / x != == &gt;= &lt;= =~ !~ &lt; &gt; | &amp;
2584     = **= += *= &amp;= &lt;&lt;= &amp;&amp;= -= /= |= &gt;&gt;= ||= //= .= %= ^= x=
2585     . : ? &amp;&amp; || and or err xor</code></pre>
2586
2587 <p>and the <b>-bbao</b> flag sets the default to break before all of these operators. These can be used to define an initial break preference which can be fine-tuned with the <b>-wba</b> and <b>-wbb</b> flags. For example, to break before all operators except an <b>=</b> one could use --bbao -wba=&#39;=&#39; rather than listing every single perl operator except <b>=</b> on a -wbb flag.</p>
2588
2589 <dl>
2590
2591 <dt id="bal-n---break-after-labels-n"><b>-bal=n, --break-after-labels=n</b></dt>
2592 <dd>
2593
2594 <p>This flag controls whether or not a line break occurs after a label. There are three possible values for <b>n</b>:</p>
2595
2596 <pre><code>  -bal=0  break if there is a break in the input [DEFAULT]
2597   -bal=1  always break after a label
2598   -bal=2  never break after a label</code></pre>
2599
2600 <p>For example,</p>
2601
2602 <pre><code>      # perltidy -bal=1
2603       RETURN:
2604         return;
2605
2606       # perltidy -bal=2
2607       RETURN: return;</code></pre>
2608
2609 </dd>
2610 </dl>
2611
2612 <h2 id="Controlling-List-Formatting">Controlling List Formatting</h2>
2613
2614 <p>Perltidy attempts to format lists of comma-separated values in tables which look good. Its default algorithms usually work well, but sometimes they don&#39;t. In this case, there are several methods available to control list formatting.</p>
2615
2616 <p>A very simple way to prevent perltidy from changing the line breaks within a comma-separated list of values is to insert a blank line, comment, or side-comment anywhere between the opening and closing parens (or braces or brackets). This causes perltidy to skip over its list formatting logic. (The reason is that any of these items put a constraint on line breaks, and perltidy needs complete control over line breaks within a container to adjust a list layout). For example, let us consider</p>
2617
2618 <pre><code>    my @list = (1,
2619                 1, 1,
2620                 1, 2, 1,
2621                 1, 3, 3, 1,
2622                 1, 4, 6, 4, 1,);</code></pre>
2623
2624 <p>The default formatting, which allows a maximum line length of 80, will flatten this down to one line:</p>
2625
2626 <pre><code>    # perltidy (default)
2627     my @list = ( 1, 1, 1, 1, 2, 1, 1, 3, 3, 1, 1, 4, 6, 4, 1, );</code></pre>
2628
2629 <p>This formatting loses the nice structure. If we place a side comment anywhere between the opening and closing parens, the original line break points are retained. For example,</p>
2630
2631 <pre><code>    my @list = (
2632         1,    # a side comment forces the original line breakpoints to be kept
2633         1, 1,
2634         1, 2, 1,
2635         1, 3, 3, 1,
2636         1, 4, 6, 4, 1,
2637     );</code></pre>
2638
2639 <p>The side comment can be a single hash symbol without any text. We could achieve the same result with a blank line or full comment anywhere between the opening and closing parens. Vertical alignment of the list items will still occur if possible.</p>
2640
2641 <p>For another possibility see the -fs flag in <a href="#Skipping-Selected-Sections-of-Code">&quot;Skipping Selected Sections of Code&quot;</a>.</p>
2642
2643 <dl>
2644
2645 <dt id="boc---break-at-old-comma-breakpoints"><b>-boc</b>, <b>--break-at-old-comma-breakpoints</b></dt>
2646 <dd>
2647
2648 <p>The <b>-boc</b> flag is another way to prevent comma-separated lists from being reformatted. Using <b>-boc</b> on the above example, plus additional flags to retain the original style, yields</p>
2649
2650 <pre><code>    # perltidy -boc -lp -pt=2 -vt=1 -vtc=1
2651     my @list = (1,
2652                 1, 1,
2653                 1, 2, 1,
2654                 1, 3, 3, 1,
2655                 1, 4, 6, 4, 1,);</code></pre>
2656
2657 <p>A disadvantage of this flag compared to the methods discussed above is that all tables in the file must already be nicely formatted.</p>
2658
2659 </dd>
2660 <dt id="mft-n---maximum-fields-per-table-n"><b>-mft=n</b>, <b>--maximum-fields-per-table=n</b></dt>
2661 <dd>
2662
2663 <p>If <b>n</b> is a positive number, and the computed number of fields for any table exceeds <b>n</b>, then it will be reduced to <b>n</b>. This parameter might be used on a small section of code to force a list to have a particular number of fields per line, and then either the <b>-boc</b> flag could be used to retain this formatting, or a single comment could be introduced somewhere to freeze the formatting in future applications of perltidy. For example</p>
2664
2665 <pre><code>    # perltidy -mft=2
2666     @month_of_year = (
2667         &#39;Jan&#39;, &#39;Feb&#39;,
2668         &#39;Mar&#39;, &#39;Apr&#39;,
2669         &#39;May&#39;, &#39;Jun&#39;,
2670         &#39;Jul&#39;, &#39;Aug&#39;,
2671         &#39;Sep&#39;, &#39;Oct&#39;,
2672         &#39;Nov&#39;, &#39;Dec&#39;
2673     );</code></pre>
2674
2675 <p>The default value is <b>n=0</b>, which does not place a limit on the number of fields in a table.</p>
2676
2677 </dd>
2678 <dt id="cab-n---comma-arrow-breakpoints-n"><b>-cab=n</b>, <b>--comma-arrow-breakpoints=n</b></dt>
2679 <dd>
2680
2681 <p>A comma which follows a comma arrow, &#39;=&gt;&#39;, is given special consideration. In a long list, it is common to break at all such commas. This parameter can be used to control how perltidy breaks at these commas. (However, it will have no effect if old comma breaks are being forced because <b>-boc</b> is used). The possible values of <b>n</b> are:</p>
2682
2683 <pre><code> n=0 break at all commas after =&gt;
2684  n=1 stable: break at all commas after =&gt; if container is open,
2685      EXCEPT FOR one-line containers
2686  n=2 break at all commas after =&gt;, BUT try to form the maximum
2687      one-line container lengths
2688  n=3 do not treat commas after =&gt; specially at all
2689  n=4 break everything: like n=0 but ALSO break a short container with
2690      a =&gt; not followed by a comma when -vt=0 is used
2691  n=5 stable: like n=1 but ALSO break at open one-line containers when
2692      -vt=0 is used (default)</code></pre>
2693
2694 <p>For example, given the following single line, perltidy by default will not add any line breaks because it would break the existing one-line container:</p>
2695
2696 <pre><code>    bless { B =&gt; $B, Root =&gt; $Root } =&gt; $package;</code></pre>
2697
2698 <p>Using <b>-cab=0</b> will force a break after each comma-arrow item:</p>
2699
2700 <pre><code>    # perltidy -cab=0:
2701     bless {
2702         B    =&gt; $B,
2703         Root =&gt; $Root
2704     } =&gt; $package;</code></pre>
2705
2706 <p>If perltidy is subsequently run with this container broken, then by default it will break after each &#39;=&gt;&#39; because the container is now broken. To reform a one-line container, the parameter <b>-cab=2</b> could be used.</p>
2707
2708 <p>The flag <b>-cab=3</b> can be used to prevent these commas from being treated specially. In this case, an item such as &quot;01&quot; =&gt; 31 is treated as a single item in a table. The number of fields in this table will be determined by the same rules that are used for any other table. Here is an example.</p>
2709
2710 <pre><code>    # perltidy -cab=3
2711     my %last_day = (
2712         &quot;01&quot; =&gt; 31, &quot;02&quot; =&gt; 29, &quot;03&quot; =&gt; 31, &quot;04&quot; =&gt; 30,
2713         &quot;05&quot; =&gt; 31, &quot;06&quot; =&gt; 30, &quot;07&quot; =&gt; 31, &quot;08&quot; =&gt; 31,
2714         &quot;09&quot; =&gt; 30, &quot;10&quot; =&gt; 31, &quot;11&quot; =&gt; 30, &quot;12&quot; =&gt; 31
2715     );</code></pre>
2716
2717 </dd>
2718 </dl>
2719
2720 <h2 id="Adding-and-Deleting-Commas">Adding and Deleting Commas</h2>
2721
2722 <dl>
2723
2724 <dt id="drc---delete-repeated-commas"><b>-drc</b>, <b>--delete-repeated-commas</b></dt>
2725 <dd>
2726
2727 <p>Repeated commas in a list are undesirable and can be removed with this flag. For example, given this list with a repeated comma</p>
2728
2729 <pre><code>      ignoreSpec( $file, &quot;file&quot;,, \%spec, \%Rspec );</code></pre>
2730
2731 <p>we can remove it with -drc</p>
2732
2733 <pre><code>      # perltidy -drc:
2734       ignoreSpec( $file, &quot;file&quot;, \%spec, \%Rspec );</code></pre>
2735
2736 <p>Since the default is not to add or delete commas, this feature is off by default and must be requested.</p>
2737
2738 </dd>
2739 <dt id="want-trailing-commas-s-or--wtc-s---add-trailing-commas-or--atc-and---delete-trailing-commas-or--dtc"><b>--want-trailing-commas=s</b> or <b>-wtc=s</b>, <b>--add-trailing-commas</b> or <b>-atc</b>, and <b>--delete-trailing-commas</b> or <b>-dtc</b></dt>
2740 <dd>
2741
2742 <p>A trailing comma is a comma following the last item of a list. Perl allows trailing commas but they are not required. By default, perltidy does not add or delete trailing commas, but it is possible to manipulate them with the following set of three related parameters:</p>
2743
2744 <pre><code>  --want-trailing-commas=s, -wtc=s - defines where trailing commas are wanted
2745   --add-trailing-commas,    -atc   - gives permission to add trailing commas to match the style wanted
2746   --delete-trailing-commas, -dtc   - gives permission to delete trailing commas which do not match the style wanted</code></pre>
2747
2748 <p>The parameter <b>--want-trailing-commas=s</b>, or <b>-wtc=s</b>, defines a preferred style. The string <b>s</b> indicates which lists should get trailing commas, as follows:</p>
2749
2750 <pre><code>  s=0 : no list should have a trailing comma
2751   s=1 or * : every list should have a trailing comma
2752   s=m a multi-line list should have a trailing commas
2753   s=b trailing commas should be &#39;bare&#39; (comma followed by newline)
2754   s=h lists of key=&gt;value pairs, with about one one &#39;=&gt;&#39; and one &#39;,&#39; per line,
2755       with a bare trailing comma
2756   s=i lists with about one comma per line, with a bare trailing comma
2757   s=&#39; &#39; or -wtc not defined : leave trailing commas unchanged [DEFAULT].</code></pre>
2758
2759 <p>This parameter by itself only indicates the where trailing commas are wanted. Perltidy only adds these trailing commas if the flag <b>--add-trailing-commas</b>, or <b>-atc</b> is set. And perltidy only removes unwanted trailing commas if the flag <b>--delete-trailing-commas</b>, or <b>-dtc</b> is set.</p>
2760
2761 <p>Here are some example parameter combinations and their meanings</p>
2762
2763 <pre><code>  -wtc=0 -dtc   : delete all trailing commas
2764   -wtc=1 -atc   : all lists get trailing commas
2765   -wtc=m -atc   : all multi-line lists get trailing commas, but
2766                   single line lists remain unchanged.
2767   -wtc=m -dtc   : multi-line lists remain unchanged, but
2768                   any trailing commas on single line lists are removed.
2769   -wtc=m -atc -dtc  : all multi-line lists get trailing commas, and
2770                       any trailing commas on single line lists are removed.</code></pre>
2771
2772 <p>For example, given the following input without a trailing comma</p>
2773
2774 <pre><code>    bless {
2775         B    =&gt; $B,
2776         Root =&gt; $Root
2777     } =&gt; $package;</code></pre>
2778
2779 <p>we can add a trailing comma after the variable <code>$Root</code> using</p>
2780
2781 <pre><code>    # perltidy -wtc=m -atc
2782     bless {
2783         B    =&gt; $B,
2784         Root =&gt; $Root,
2785     } =&gt; $package;</code></pre>
2786
2787 <p>This could also be achieved in this case with <b>-wtc=b</b> instead of <b>-wtc=m</b> because the trailing comma here is bare (separated from its closing brace by a newline). And it could also be achieved with <b>-wtc=h</b> because this particular list is a list of key=&gt;value pairs.</p>
2788
2789 <p>The above styles should cover the main of situations of interest, but it is possible to apply a different style to each type of container token by including an opening token ahead of the style character in the above table. For example</p>
2790
2791 <pre><code>    -wtc=&#39;(m [b&#39;</code></pre>
2792
2793 <p>means that lists within parens should have multi-line trailing commas, and that lists within square brackets have bare trailing commas. Since there is no specification for curly braces in this example, their trailing commas would remain unchanged.</p>
2794
2795 <p>For parentheses, an additional item of information which can be given is an alphanumeric letter which is used to limit the selection further depending on the type of token immediately before the opening paren. The possible letters are currently &#39;k&#39;, &#39;K&#39;, &#39;f&#39;, &#39;F&#39;, &#39;w&#39;, and &#39;W&#39;, with these meanings for matching whatever precedes an opening paren:</p>
2796
2797 <pre><code> &#39;k&#39; matches if the previous nonblank token is a perl built-in keyword (such as &#39;if&#39;, &#39;while&#39;),
2798  &#39;K&#39; matches if &#39;k&#39; does not, meaning that the previous token is not a keyword.
2799  &#39;f&#39; matches if the previous token is a function other than a keyword.
2800  &#39;F&#39; matches if &#39;f&#39; does not.
2801  &#39;w&#39; matches if either &#39;k&#39; or &#39;f&#39; match.
2802  &#39;W&#39; matches if &#39;w&#39; does not.</code></pre>
2803
2804 <p>These are the same codes used for <b>--line-up-parentheses-inclusion-list</b>. For example,</p>
2805
2806 <pre><code>  -wtc = &#39;w(m&#39;</code></pre>
2807
2808 <p>means that trailing commas are wanted for multi-line parenthesized lists following a function call or keyword.</p>
2809
2810 <p>Here are some points to note regarding adding and deleting trailing commas:</p>
2811
2812 <ul>
2813
2814 <li><p>For the implementation of these parameters, a <b>list</b> is basically taken to be a container of items (parens, square brackets, or braces), which is not a code block, with one or more commas. These parameters only apply to something that fits this definition of a list.</p>
2815
2816 <p>Note that a paren-less list of parameters is not a list by this definition, so these parameters have no effect on a peren-less list.</p>
2817
2818 <p>Another consequence is that if the only comma in a list is deleted, then it cannot later be added back with these parameters because the container no longer fits this definition of a list. For example, given</p>
2819
2820 <pre><code>    my ( $self, ) = @_;</code></pre>
2821
2822 <p>and if we remove the comma with</p>
2823
2824 <pre><code>    # perltidy -wtc=m -dtc
2825     my ( $self ) = @_;</code></pre>
2826
2827 <p>then we cannot use these trailing comma controls to add this comma back.</p>
2828
2829 </li>
2830 <li><p>By <b>multiline</b> list is meant a list for which the first comma and trailing comma are on different lines.</p>
2831
2832 </li>
2833 <li><p>A <b>bare</b> trailing comma is a comma which is at the end of a line. That is, the closing container token follows on a different line. So a list with a bare trailing comma is a special case of a multi-line list.</p>
2834
2835 </li>
2836 <li><p>The decision regarding whether or not a list is multi-line or bare is made based on the <b>input</b> stream. In some cases it may take an iteration or two to reach a final state.</p>
2837
2838 </li>
2839 <li><p>When using these parameters for the first time it is a good idea to practice on some test scripts and verify that the results are as expected.</p>
2840
2841 </li>
2842 <li><p>Since the default behavior is not to add or delete commas, these parameters can be useful on a temporary basis for reformatting a script.</p>
2843
2844 </li>
2845 </ul>
2846
2847 </dd>
2848 <dt id="dwic---delete-weld-interfering-commas"><b>-dwic</b>, <b>--delete-weld-interfering-commas</b></dt>
2849 <dd>
2850
2851 <p>If the closing tokens of two nested containers are separated by a comma, then welding requested with <b>--weld-nested-containers</b> cannot occur. Any commas in this situation are optional trailing commas and can be removed with <b>-dwic</b>. For example, a comma in this script prevents welding:</p>
2852
2853 <pre><code>    # perltidy -wn
2854     skip_symbols(
2855         [ qw(
2856             Perl_dump_fds
2857             Perl_ErrorNo
2858             Perl_GetVars
2859             PL_sys_intern
2860         ) ],
2861     );</code></pre>
2862
2863 <p>Using <b>-dwic</b> removes the comma and allows welding:</p>
2864
2865 <pre><code>    # perltidy -wn -dwic
2866     skip_symbols( [ qw(
2867         Perl_dump_fds
2868         Perl_ErrorNo
2869         Perl_GetVars
2870         PL_sys_intern
2871     ) ] );</code></pre>
2872
2873 <p>Since the default is not to add or delete commas, this feature is off by default. Here are some points to note about the <b>-dwic</b> parameter</p>
2874
2875 <ul>
2876
2877 <li><p>This operation is not reversible, so please check results of using this parameter carefully.</p>
2878
2879 </li>
2880 <li><p>Removing this type of isolated trailing comma is necessary for welding to be possible, but not sufficient. So welding will not always occur where these commas are removed.</p>
2881
2882 </li>
2883 </ul>
2884
2885 </dd>
2886 </dl>
2887
2888 <h2 id="Retaining-or-Ignoring-Existing-Line-Breaks">Retaining or Ignoring Existing Line Breaks</h2>
2889
2890 <p>Several additional parameters are available for controlling the extent to which line breaks in the input script influence the output script. In most cases, the default parameter values are set so that, if a choice is possible, the output style follows the input style. For example, if a short logical container is broken in the input script, then the default behavior is for it to remain broken in the output script.</p>
2891
2892 <p>Most of the parameters in this section would only be required for a one-time conversion of a script from short container lengths to longer container lengths. The opposite effect, of converting long container lengths to shorter lengths, can be obtained by temporarily using a short maximum line length.</p>
2893
2894 <dl>
2895
2896 <dt id="bol---break-at-old-logical-breakpoints"><b>-bol</b>, <b>--break-at-old-logical-breakpoints</b></dt>
2897 <dd>
2898
2899 <p>By default, if a logical expression is broken at a <code>&amp;&amp;</code>, <code>||</code>, <code>and</code>, or <code>or</code>, then the container will remain broken. Also, breaks at internal keywords <code>if</code> and <code>unless</code> will normally be retained. To prevent this, and thus form longer lines, use <b>-nbol</b>.</p>
2900
2901 <p>Please note that this flag does not duplicate old logical breakpoints. They are merely used as a hint with this flag that a statement should remain broken. Without this flag, perltidy will normally try to combine relatively short expressions into a single line.</p>
2902
2903 <p>For example, given this snippet:</p>
2904
2905 <pre><code>    return unless $cmd = $cmd || ($dot
2906         &amp;&amp; $Last_Shell) || &amp;prompt(&#39;|&#39;);
2907
2908     # perltidy -bol [default]
2909     return
2910       unless $cmd = $cmd
2911       || ( $dot
2912         &amp;&amp; $Last_Shell )
2913       || &amp;prompt(&#39;|&#39;);
2914
2915     # perltidy -nbol
2916     return unless $cmd = $cmd || ( $dot &amp;&amp; $Last_Shell ) || &amp;prompt(&#39;|&#39;);</code></pre>
2917
2918 </dd>
2919 <dt id="bom---break-at-old-method-breakpoints"><b>-bom</b>, <b>--break-at-old-method-breakpoints</b></dt>
2920 <dd>
2921
2922 <p>By default, a method call arrow <code>-&gt;</code> is considered a candidate for a breakpoint, but method chains will fill to the line width before a break is considered. With <b>-bom</b>, breaks before the arrow are preserved, so if you have pre-formatted a method chain:</p>
2923
2924 <pre><code>  my $q = $rs
2925     -&gt;related_resultset(&#39;CDs&#39;)
2926     -&gt;related_resultset(&#39;Tracks&#39;)
2927     -&gt;search({
2928       &#39;track.id&#39; =&gt; {-ident =&gt; &#39;none_search.id&#39;},
2929     })-&gt;as_query;</code></pre>
2930
2931 <p>It will <b>keep</b> these breaks, rather than become this:</p>
2932
2933 <pre><code>  my $q = $rs-&gt;related_resultset(&#39;CDs&#39;)-&gt;related_resultset(&#39;Tracks&#39;)-&gt;search({
2934       &#39;track.id&#39; =&gt; {-ident =&gt; &#39;none_search.id&#39;},
2935     })-&gt;as_query;</code></pre>
2936
2937 <p>This flag will also look for and keep a &#39;cuddled&#39; style of calls, in which lines begin with a closing paren followed by a call arrow, as in this example:</p>
2938
2939 <pre><code>  # perltidy -bom -wn
2940   my $q = $rs-&gt;related_resultset(
2941       &#39;CDs&#39;
2942   )-&gt;related_resultset(
2943       &#39;Tracks&#39;
2944   )-&gt;search( {
2945       &#39;track.id&#39; =&gt; { -ident =&gt; &#39;none_search.id&#39; },
2946   } )-&gt;as_query;</code></pre>
2947
2948 <p>You may want to include the <b>-weld-nested-containers</b> flag in this case to keep nested braces and parens together, as in the last line.</p>
2949
2950 </dd>
2951 <dt id="bos---break-at-old-semicolon-breakpoints"><b>-bos</b>, <b>--break-at-old-semicolon-breakpoints</b></dt>
2952 <dd>
2953
2954 <p>Semicolons are normally placed at the end of a statement. This means that formatted lines do not normally begin with semicolons. If the input stream has some lines which begin with semicolons, these can be retained by setting this flag. For example, consider the following two-line input snippet:</p>
2955
2956 <pre><code>  $z = sqrt($x**2 + $y**2)
2957   ;</code></pre>
2958
2959 <p>The default formatting will be:</p>
2960
2961 <pre><code>  $z = sqrt( $x**2 + $y**2 );</code></pre>
2962
2963 <p>The result using <b>perltidy -bos</b> keeps the isolated semicolon:</p>
2964
2965 <pre><code>  $z = sqrt( $x**2 + $y**2 )
2966     ;</code></pre>
2967
2968 <p>The default is not to do this, <b>-nbos</b>.</p>
2969
2970 </dd>
2971 <dt id="bok---break-at-old-keyword-breakpoints"><b>-bok</b>, <b>--break-at-old-keyword-breakpoints</b></dt>
2972 <dd>
2973
2974 <p>By default, perltidy will retain a breakpoint before keywords which may return lists, such as <code>sort</code> and &lt;map&gt;. This allows chains of these operators to be displayed one per line. Use <b>-nbok</b> to prevent retaining these breakpoints.</p>
2975
2976 </dd>
2977 <dt id="bot---break-at-old-ternary-breakpoints"><b>-bot</b>, <b>--break-at-old-ternary-breakpoints</b></dt>
2978 <dd>
2979
2980 <p>By default, if a conditional (ternary) operator is broken at a <code>:</code>, then it will remain broken. To prevent this, and thereby form longer lines, use <b>-nbot</b>.</p>
2981
2982 </dd>
2983 <dt id="boa---break-at-old-attribute-breakpoints"><b>-boa</b>, <b>--break-at-old-attribute-breakpoints</b></dt>
2984 <dd>
2985
2986 <p>By default, if an attribute list is broken at a <code>:</code> in the source file, then it will remain broken. For example, given the following code, the line breaks at the &#39;:&#39;s will be retained:</p>
2987
2988 <pre><code>                    my @field
2989                       : field
2990                       : Default(1)
2991                       : Get(&#39;Name&#39; =&gt; &#39;foo&#39;) : Set(&#39;Name&#39;);</code></pre>
2992
2993 <p>If the attributes are on a single line in the source code then they will remain on a single line if possible.</p>
2994
2995 <p>To prevent this, and thereby always form longer lines, use <b>-nboa</b>.</p>
2996
2997 </dd>
2998 <dt id="Keeping-old-breakpoints-at-specific-token-types"><b>Keeping old breakpoints at specific token types</b></dt>
2999 <dd>
3000
3001 <p>It is possible to override the choice of line breaks made by perltidy, and force it to follow certain line breaks in the input stream, with these two parameters:</p>
3002
3003 <p><b>-kbb=s</b> or <b>--keep-old-breakpoints-before=s</b>, and</p>
3004
3005 <p><b>-kba=s</b> or <b>--keep-old-breakpoints-after=s</b></p>
3006
3007 <p>These parameters are each followed by a quoted string, <b>s</b>, containing a list of token types (separated only by spaces). No more than one of each of these parameters should be specified, because repeating a command-line parameter always overwrites the previous one before perltidy ever sees it.</p>
3008
3009 <p>For example, -kbb=&#39;=&gt;&#39; means that if an input line begins with a &#39;=&gt;&#39; then the output script should also have a line break before that token.</p>
3010
3011 <p>For example, given the script:</p>
3012
3013 <pre><code>    method &#39;foo&#39;
3014       =&gt; [ Int, Int ]
3015       =&gt; sub {
3016         my ( $self, $x, $y ) = ( shift, @_ );
3017         ...;
3018       };
3019
3020     # perltidy [default]
3021     method &#39;foo&#39; =&gt; [ Int, Int ] =&gt; sub {
3022         my ( $self, $x, $y ) = ( shift, @_ );
3023         ...;
3024     };
3025
3026     # perltidy -kbb=&#39;=&gt;&#39;
3027     method &#39;foo&#39;
3028       =&gt; [ Int, Int ]
3029       =&gt; sub {
3030         my ( $self, $x, $y ) = ( shift, @_ );
3031         ...;
3032       };</code></pre>
3033
3034 <p>For the container tokens &#39;{&#39;, &#39;[&#39; and &#39;(&#39; and, their closing counterparts, use the token symbol. Thus, the command to keep a break after all opening parens is:</p>
3035
3036 <pre><code>   perltidy -kba=&#39;(&#39;</code></pre>
3037
3038 <p>It is possible to be more specific in matching parentheses by preceding them with a letter. The possible letters are &#39;k&#39;, &#39;K&#39;, &#39;f&#39;, &#39;F&#39;, &#39;w&#39;, and &#39;W&#39;, with these meanings (these are the same as used in the <b>--weld-nested-exclusion-list</b> and <b>--line-up-parentheses-exclusion-list</b> parameters):</p>
3039
3040 <pre><code> &#39;k&#39; matches if the previous nonblank token is a perl built-in keyword (such as &#39;if&#39;, &#39;while&#39;),
3041  &#39;K&#39; matches if &#39;k&#39; does not, meaning that the previous token is not a keyword.
3042  &#39;f&#39; matches if the previous token is a function other than a keyword.
3043  &#39;F&#39; matches if &#39;f&#39; does not.
3044  &#39;w&#39; matches if either &#39;k&#39; or &#39;f&#39; match.
3045  &#39;W&#39; matches if &#39;w&#39; does not.</code></pre>
3046
3047 <p>So for example the the following parameter will keep breaks after opening function call parens:</p>
3048
3049 <pre><code>   perltidy -kba=&#39;f(&#39;</code></pre>
3050
3051 <p><b>NOTE</b>: A request to break before an opening container, such as <b>-kbb=&#39;(&#39;</b>, will be silently ignored because it can lead to formatting instability. Likewise, a request to break after a closing container, such as <b>-kba</b>=&#39;)&#39;, will also be silently ignored.</p>
3052
3053 </dd>
3054 <dt id="iob---ignore-old-breakpoints"><b>-iob</b>, <b>--ignore-old-breakpoints</b></dt>
3055 <dd>
3056
3057 <p>Use this flag to tell perltidy to ignore existing line breaks to the maximum extent possible. This will tend to produce the longest possible containers, regardless of type, which do not exceed the line length limit. But please note that this parameter has priority over all other parameters requesting that certain old breakpoints be kept.</p>
3058
3059 <p>To illustrate, consider the following input text:</p>
3060
3061 <pre><code>    has subcmds =&gt; (
3062         is =&gt; &#39;ro&#39;,
3063         default =&gt; sub { [] },
3064     );</code></pre>
3065
3066 <p>The default formatting will keep the container broken, giving</p>
3067
3068 <pre><code>    # perltidy [default]
3069     has subcmds =&gt; (
3070         is      =&gt; &#39;ro&#39;,
3071         default =&gt; sub { [] },
3072     );</code></pre>
3073
3074 <p>If old breakpoints are ignored, the list will be flattened:</p>
3075
3076 <pre><code>    # perltidy -iob
3077     has subcmds =&gt; ( is =&gt; &#39;ro&#39;, default =&gt; sub { [] }, );</code></pre>
3078
3079 <p>Besides flattening lists, this parameter also applies to lines broken at certain logical breakpoints such as &#39;if&#39; and &#39;or&#39;.</p>
3080
3081 <p>Even if this is parameter is not used globally, it provides a convenient way to flatten selected lists from within an editor.</p>
3082
3083 </dd>
3084 <dt id="kis---keep-interior-semicolons"><b>-kis</b>, <b>--keep-interior-semicolons</b></dt>
3085 <dd>
3086
3087 <p>Use the <b>-kis</b> flag to prevent breaking at a semicolon if there was no break there in the input file. Normally perltidy places a newline after each semicolon which terminates a statement unless several statements are contained within a one-line brace block. To illustrate, consider the following input lines:</p>
3088
3089 <pre><code>    dbmclose(%verb_delim); undef %verb_delim;
3090     dbmclose(%expanded); undef %expanded;</code></pre>
3091
3092 <p>The default is to break after each statement, giving</p>
3093
3094 <pre><code>    dbmclose(%verb_delim);
3095     undef %verb_delim;
3096     dbmclose(%expanded);
3097     undef %expanded;</code></pre>
3098
3099 <p>With <b>perltidy -kis</b> the multiple statements are retained:</p>
3100
3101 <pre><code>    dbmclose(%verb_delim); undef %verb_delim;
3102     dbmclose(%expanded);   undef %expanded;</code></pre>
3103
3104 <p>The statements are still subject to the specified value of <b>maximum-line-length</b> and will be broken if this maximum is exceeded.</p>
3105
3106 </dd>
3107 </dl>
3108
3109 <h2 id="Blank-Line-Control">Blank Line Control</h2>
3110
3111 <p>Blank lines can improve the readability of a script if they are carefully placed. Perltidy has several commands for controlling the insertion, retention, and removal of blank lines.</p>
3112
3113 <dl>
3114
3115 <dt id="fbl---freeze-blank-lines"><b>-fbl</b>, <b>--freeze-blank-lines</b></dt>
3116 <dd>
3117
3118 <p>Set <b>-fbl</b> if you want to the blank lines in your script to remain exactly as they are. The rest of the parameters in this section may then be ignored. (Note: setting the <b>-fbl</b> flag is equivalent to setting <b>-mbl=0</b> and <b>-kbl=2</b>).</p>
3119
3120 </dd>
3121 <dt id="bbc---blanks-before-comments"><b>-bbc</b>, <b>--blanks-before-comments</b></dt>
3122 <dd>
3123
3124 <p>A blank line will be introduced before a full-line comment. This is the default. Use <b>-nbbc</b> or <b>--noblanks-before-comments</b> to prevent such blank lines from being introduced.</p>
3125
3126 </dd>
3127 <dt id="blbs-n---blank-lines-before-subs-n"><b>-blbs=n</b>, <b>--blank-lines-before-subs=n</b></dt>
3128 <dd>
3129
3130 <p>The parameter <b>-blbs=n</b> requests that least <b>n</b> blank lines precede a sub definition which does not follow a comment and which is more than one-line long. The default is &lt;-blbs=1&gt;. <b>BEGIN</b> and <b>END</b> blocks are included.</p>
3131
3132 <p>The requested number of blanks statement will be inserted regardless of the value of <b>--maximum-consecutive-blank-lines=n</b> (<b>-mbl=n</b>) with the exception that if <b>-mbl=0</b> then no blanks will be output.</p>
3133
3134 <p>This parameter interacts with the value <b>k</b> of the parameter <b>--maximum-consecutive-blank-lines=k</b> (<b>-mbl=k</b>) as follows:</p>
3135
3136 <p>1. If <b>-mbl=0</b> then no blanks will be output. This allows all blanks to be suppressed with a single parameter. Otherwise,</p>
3137
3138 <p>2. If the number of old blank lines in the script is less than <b>n</b> then additional blanks will be inserted to make the total <b>n</b> regardless of the value of <b>-mbl=k</b>.</p>
3139
3140 <p>3. If the number of old blank lines in the script equals or exceeds <b>n</b> then this parameter has no effect, however the total will not exceed value specified on the <b>-mbl=k</b> flag.</p>
3141
3142 </dd>
3143 <dt id="blbp-n---blank-lines-before-packages-n"><b>-blbp=n</b>, <b>--blank-lines-before-packages=n</b></dt>
3144 <dd>
3145
3146 <p>The parameter <b>-blbp=n</b> requests that least <b>n</b> blank lines precede a package which does not follow a comment. The default is <b>-blbp=1</b>.</p>
3147
3148 <p>This parameter interacts with the value <b>k</b> of the parameter <b>--maximum-consecutive-blank-lines=k</b> (<b>-mbl=k</b>) in the same way as described for the previous item <b>-blbs=n</b>.</p>
3149
3150 </dd>
3151 <dt id="bbs---blanks-before-subs"><b>-bbs</b>, <b>--blanks-before-subs</b></dt>
3152 <dd>
3153
3154 <p>For compatibility with previous versions, <b>-bbs</b> or <b>--blanks-before-subs</b> is equivalent to <i>-blbp=1</i> and <i>-blbs=1</i>.</p>
3155
3156 <p>Likewise, <b>-nbbs</b> or <b>--noblanks-before-subs</b> is equivalent to <i>-blbp=0</i> and <i>-blbs=0</i>.</p>
3157
3158 </dd>
3159 <dt id="bbb---blanks-before-blocks"><b>-bbb</b>, <b>--blanks-before-blocks</b></dt>
3160 <dd>
3161
3162 <p>A blank line will be introduced before blocks of coding delimited by <b>for</b>, <b>foreach</b>, <b>while</b>, <b>until</b>, and <b>if</b>, <b>unless</b>, in the following circumstances:</p>
3163
3164 <ul>
3165
3166 <li><p>The block is not preceded by a comment.</p>
3167
3168 </li>
3169 <li><p>The block is not a one-line block.</p>
3170
3171 </li>
3172 <li><p>The number of consecutive non-blank lines at the current indentation depth is at least <b>-lbl</b> (see next section).</p>
3173
3174 </li>
3175 </ul>
3176
3177 <p>This is the default. The intention of this option is to introduce some space within dense coding. This is negated with <b>-nbbb</b> or <b>--noblanks-before-blocks</b>.</p>
3178
3179 </dd>
3180 <dt id="lbl-n---long-block-line-count-n"><b>-lbl=n</b> <b>--long-block-line-count=n</b></dt>
3181 <dd>
3182
3183 <p>This controls how often perltidy is allowed to add blank lines before certain block types (see previous section). The default is 8. Entering a value of <b>0</b> is equivalent to entering a very large number.</p>
3184
3185 </dd>
3186 <dt id="blao-i-or---blank-lines-after-opening-block-i"><b>-blao=i</b> or <b>--blank-lines-after-opening-block=i</b></dt>
3187 <dd>
3188
3189 <p>This control places a minimum of <b>i</b> blank lines <b>after</b> a line which <b>ends</b> with an opening block brace of a specified type. By default, this only applies to the block of a named <b>sub</b>, but this can be changed (see <b>-blaol</b> below). The default is not to do this (<b>i=0</b>).</p>
3190
3191 <p>Please see the note below on using the <b>-blao</b> and <b>-blbc</b> options.</p>
3192
3193 </dd>
3194 <dt id="blbc-i-or---blank-lines-before-closing-block-i"><b>-blbc=i</b> or <b>--blank-lines-before-closing-block=i</b></dt>
3195 <dd>
3196
3197 <p>This control places a minimum of <b>i</b> blank lines <b>before</b> a line which <b>begins</b> with a closing block brace of a specified type. By default, this only applies to the block of a named <b>sub</b>, but this can be changed (see <b>-blbcl</b> below). The default is not to do this (<b>i=0</b>).</p>
3198
3199 </dd>
3200 <dt id="blaol-s-or---blank-lines-after-opening-block-list-s"><b>-blaol=s</b> or <b>--blank-lines-after-opening-block-list=s</b></dt>
3201 <dd>
3202
3203 <p>The parameter <b>s</b> is a list of block type keywords to which the flag <b>-blao</b> should apply. The section <a href="#Specifying-Block-Types">&quot;Specifying Block Types&quot;</a> explains how to list block types.</p>
3204
3205 </dd>
3206 <dt id="blbcl-s-or---blank-lines-before-closing-block-list-s"><b>-blbcl=s</b> or <b>--blank-lines-before-closing-block-list=s</b></dt>
3207 <dd>
3208
3209 <p>This parameter is a list of block type keywords to which the flag <b>-blbc</b> should apply. The section <a href="#Specifying-Block-Types">&quot;Specifying Block Types&quot;</a> explains how to list block types.</p>
3210
3211 </dd>
3212 <dt id="Note-on-using-the--blao-and--blbc-options"><b>Note on using the</b> <b>-blao</b> and <b>-blbc</b> options.</dt>
3213 <dd>
3214
3215 <p>These blank line controls introduce a certain minimum number of blank lines in the text, but the final number of blank lines may be greater, depending on values of the other blank line controls and the number of old blank lines. A consequence is that introducing blank lines with these and other controls cannot be exactly undone, so some experimentation with these controls is recommended before using them.</p>
3216
3217 <p>For example, suppose that for some reason we decide to introduce one blank space at the beginning and ending of all blocks. We could do this using</p>
3218
3219 <pre><code>  perltidy -blao=2 -blbc=2 -blaol=&#39;*&#39; -blbcl=&#39;*&#39; filename</code></pre>
3220
3221 <p>Now suppose the script continues to be developed, but at some later date we decide we don&#39;t want these spaces after all. We might expect that running with the flags <b>-blao=0</b> and <b>-blbc=0</b> will undo them. However, by default perltidy retains single blank lines, so the blank lines remain.</p>
3222
3223 <p>We can easily fix this by telling perltidy to ignore old blank lines by including the added parameter <b>-kbl=0</b> and rerunning. Then the unwanted blank lines will be gone. However, this will cause all old blank lines to be ignored, perhaps even some that were added by hand to improve formatting. So please be cautious when using these parameters.</p>
3224
3225 </dd>
3226 <dt id="mbl-n---maximum-consecutive-blank-lines-n"><b>-mbl=n</b> <b>--maximum-consecutive-blank-lines=n</b></dt>
3227 <dd>
3228
3229 <p>This parameter specifies the maximum number of consecutive blank lines which will be output within code sections of a script. The default is n=1. If the input file has more than n consecutive blank lines, the number will be reduced to n except as noted above for the <b>-blbp</b> and <b>-blbs</b> parameters. If <b>n=0</b> then no blank lines will be output (unless all old blank lines are retained with the <b>-kbl=2</b> flag of the next section).</p>
3230
3231 <p>This flag obviously does not apply to pod sections, here-documents, and quotes.</p>
3232
3233 </dd>
3234 <dt id="kbl-n---keep-old-blank-lines-n"><b>-kbl=n</b>, <b>--keep-old-blank-lines=n</b></dt>
3235 <dd>
3236
3237 <p>The <b>-kbl=n</b> flag gives you control over how your existing blank lines are treated.</p>
3238
3239 <p>The possible values of <b>n</b> are:</p>
3240
3241 <pre><code> n=0 ignore all old blank lines
3242  n=1 stable: keep old blanks, but limited by the value of the B&lt;-mbl=n&gt; flag
3243  n=2 keep all old blank lines, regardless of the value of the B&lt;-mbl=n&gt; flag</code></pre>
3244
3245 <p>The default is <b>n=1</b>.</p>
3246
3247 </dd>
3248 <dt id="sob---swallow-optional-blank-lines"><b>-sob</b>, <b>--swallow-optional-blank-lines</b></dt>
3249 <dd>
3250
3251 <p>This is equivalent to <b>kbl=0</b> and is included for compatibility with previous versions.</p>
3252
3253 </dd>
3254 <dt id="nsob---noswallow-optional-blank-lines"><b>-nsob</b>, <b>--noswallow-optional-blank-lines</b></dt>
3255 <dd>
3256
3257 <p>This is equivalent to <b>kbl=1</b> and is included for compatibility with previous versions.</p>
3258
3259 </dd>
3260 </dl>
3261
3262 <p><b>Controls for blank lines around lines of consecutive keywords</b></p>
3263
3264 <p>The parameters in this section provide some control over the placement of blank lines within and around groups of statements beginning with selected keywords. These blank lines are called here <b>keyword group blanks</b>, and all of the parameters begin with <b>--keyword-group-blanks*</b>, or <b>-kgb*</b> for short. The default settings do not employ these controls but they can be enabled with the following parameters:</p>
3265
3266 <p><b>-kgbl=s</b> or <b>--keyword-group-blanks-list=s</b>; <b>s</b> is a quoted string of keywords</p>
3267
3268 <p><b>-kgbs=s</b> or <b>--keyword-group-blanks-size=s</b>; <b>s</b> gives the number of keywords required to form a group.</p>
3269
3270 <p><b>-kgbb=n</b> or <b>--keyword-group-blanks-before=n</b>; <b>n</b> = (0, 1, or 2) controls a leading blank</p>
3271
3272 <p><b>-kgba=n</b> or <b>--keyword-group-blanks-after=n</b>; <b>n</b> = (0, 1, or 2) controls a trailing blank</p>
3273
3274 <p><b>-kgbi</b> or <b>--keyword-group-blanks-inside</b> is a switch for adding blanks between subgroups</p>
3275
3276 <p><b>-kgbd</b> or <b>--keyword-group-blanks-delete</b> is a switch for removing initial blank lines between keywords</p>
3277
3278 <p><b>-kgbr=n</b> or <b>--keyword-group-blanks-repeat-count=n</b> can limit the number of times this logic is applied</p>
3279
3280 <p>In addition, the following abbreviations are available to for simplified usage:</p>
3281
3282 <p><b>-kgb</b> or <b>--keyword-group-blanks</b> is short for <b>-kgbb=2 -kgba=2 kgbi</b></p>
3283
3284 <p><b>-nkgb</b> or <b>--nokeyword-group-blanks</b>, is short for <b>-kgbb=1 -kgba=1 nkgbi</b></p>
3285
3286 <p>Before describing the meaning of the parameters in detail let us look at an example which is formatted with default parameter settings.</p>
3287
3288 <pre><code>        print &quot;Entering test 2\n&quot;;
3289         use Test;
3290         use Encode qw(from_to encode decode
3291           encode_utf8 decode_utf8
3292           find_encoding is_utf8);
3293         use charnames qw(greek);
3294         my @encodings     = grep( /iso-?8859/, Encode::encodings() );
3295         my @character_set = ( &#39;0&#39; .. &#39;9&#39;, &#39;A&#39; .. &#39;Z&#39;, &#39;a&#39; .. &#39;z&#39; );
3296         my @source        = qw(ascii iso8859-1 cp1250);
3297         my @destiny       = qw(cp1047 cp37 posix-bc);
3298         my @ebcdic_sets   = qw(cp1047 cp37 posix-bc);
3299         my $str           = join( &#39;&#39;, map( chr($_), 0x20 .. 0x7E ) );
3300         return unless ($str);</code></pre>
3301
3302 <p>using <b>perltidy -kgb</b> gives:</p>
3303
3304 <pre><code>        print &quot;Entering test 2\n&quot;;
3305                                       &lt;----------this blank controlled by -kgbb
3306         use Test;
3307         use Encode qw(from_to encode decode
3308           encode_utf8 decode_utf8
3309           find_encoding is_utf8);
3310         use charnames qw(greek);
3311                                       &lt;---------this blank controlled by -kgbi
3312         my @encodings     = grep( /iso-?8859/, Encode::encodings() );
3313         my @character_set = ( &#39;0&#39; .. &#39;9&#39;, &#39;A&#39; .. &#39;Z&#39;, &#39;a&#39; .. &#39;z&#39; );
3314         my @source        = qw(ascii iso8859-1 cp1250);
3315         my @destiny       = qw(cp1047 cp37 posix-bc);
3316         my @ebcdic_sets   = qw(cp1047 cp37 posix-bc);
3317         my $str           = join( &#39;&#39;, map( chr($_), 0x20 .. 0x7E ) );
3318                                       &lt;----------this blank controlled by -kgba
3319         return unless ($str);</code></pre>
3320
3321 <p>Blank lines have been introduced around the <b>my</b> and <b>use</b> sequences. What happened is that the default keyword list includes <b>my</b> and <b>use</b> but not <b>print</b> and <b>return</b>. So a continuous sequence of nine <b>my</b> and <b>use</b> statements was located. This number exceeds the default threshold of five, so blanks were placed before and after the entire group. Then, since there was also a subsequence of six <b>my</b> lines, a blank line was introduced to separate them.</p>
3322
3323 <p>Finer control over blank placement can be achieved by using the individual parameters rather than the <b>-kgb</b> flag. The individual controls are as follows.</p>
3324
3325 <p><b>-kgbl=s</b> or <b>--keyword-group-blanks-list=s</b>, where <b>s</b> is a quoted string, defines the set of keywords which will be formed into groups. The string is a space separated list of keywords. The default set is <b>s=&quot;use require local our my&quot;</b>, but any list of keywords may be used. Comment lines may also be included in a keyword group, even though they are not keywords. To include ordinary block comments, include the symbol <b>BC</b>. To include static block comments (which normally begin with &#39;##&#39;), include the symbol <b>SBC</b>.</p>
3326
3327 <p><b>-kgbs=s</b> or <b>--keyword-group-blanks-size=s</b>, where <b>s</b> is a string describing the number of consecutive keyword statements forming a group (Note: statements separated by blank lines in the input file are considered consecutive for purposes of this count). If <b>s</b> is an integer then it is the minimum number required for a group. A maximum value may also be given with the format <b>s=min.max</b>, where <b>min</b> is the minimum number and <b>max</b> is the maximum number, and the min and max values are separated by one or more dots. No groups will be found if the maximum is less than the minimum. The maximum is unlimited if not given. The default is <b>s=5</b>. Some examples:</p>
3328
3329 <pre><code>    s      min   max         number for group
3330     3      3     unlimited   3 or more
3331     1.1    1     1           1
3332     1..3   1     3           1 to 3
3333     1.0    1     0           (no match)</code></pre>
3334
3335 <p>There is no really good default value for this parameter. If it is set too small, then an excessive number of blank lines may be generated. However, some users may prefer reducing the value somewhat below the default, perhaps to <b>s=3</b>.</p>
3336
3337 <p><b>-kgbb=n</b> or <b>--keyword-group-blanks-before=n</b> specifies whether a blank should appear before the first line of the group, as follows:</p>
3338
3339 <pre><code>   n=0 =&gt; (delete) an existing blank line will be removed
3340    n=1 =&gt; (stable) no change to the input file is made  [DEFAULT]
3341    n=2 =&gt; (insert) a blank line is introduced if possible</code></pre>
3342
3343 <p><b>-kgba=n</b> or <b>--keyword-group-blanks-after=n</b> likewise specifies whether a blank should appear after the last line of the group, using the same scheme (0=delete, 1=stable, 2=insert).</p>
3344
3345 <p><b>-kgbi</b> or <b>--keyword-group-blanks-inside</b> controls the insertion of blank lines between the first and last statement of the entire group. If there is a continuous run of a single statement type with more than the minimum threshold number (as specified with <b>-kgbs=s</b>) then this switch causes a blank line be inserted between this subgroup and the others. In the example above this happened between the <b>use</b> and <b>my</b> statements.</p>
3346
3347 <p><b>-kgbd</b> or <b>--keyword-group-blanks-delete</b> controls the deletion of any blank lines that exist in the the group when it is first scanned. When statements are initially scanned, any existing blank lines are included in the collection. Any such original blank lines will be deleted before any other insertions are made when the parameter <b>-kgbd</b> is set. The default is not to do this, <b>-nkgbd</b>.</p>
3348
3349 <p><b>-kgbr=n</b> or <b>--keyword-group-blanks-repeat-count=n</b> specifies <b>n</b>, the maximum number of times this logic will be applied to any file. The special value <b>n=0</b> is the same as n=infinity which means it will be applied to an entire script [Default]. A value <b>n=1</b> could be used to make it apply just one time for example. This might be useful for adjusting just the <b>use</b> statements in the top part of a module for example.</p>
3350
3351 <p><b>-kgb</b> or <b>--keyword-group-blanks</b> is an abbreviation equivalent to setting <b>-kgbb=1 -kgba=1 -kgbi</b>. This turns on keyword group formatting with a set of default values.</p>
3352
3353 <p><b>-nkgb</b> or <b>--nokeyword-group-blanks</b> is equivalent to <b>-kgbb=0 -kgba nkgbi</b>. This flag turns off keyword group blank lines and is the default setting.</p>
3354
3355 <p>Here are a few notes about the functioning of this technique.</p>
3356
3357 <ul>
3358
3359 <li><p>These parameters are probably more useful as part of a major code reformatting operation rather than as a routine formatting operation.</p>
3360
3361 <p>In particular, note that deleting old blank lines with <b>-kgbd</b> is an irreversible operation so it should be applied with care. Existing blank lines may be serving an important role in controlling vertical alignment.</p>
3362
3363 </li>
3364 <li><p>Conflicts which arise among these <b>kgb*</b> parameters and other blank line controls are generally resolved by producing the maximum number of blank lines implied by any parameter.</p>
3365
3366 <p>For example, if the flags <b>--freeze-blank-lines</b>, or <b>--keep-old-blank-lines=2</b>, are set, then they have priority over any blank line deletion implied by the <b>-kgb</b> flags of this section, so no blank lines will be deleted.</p>
3367
3368 <p>For another example, if a keyword group ends at a <b>sub</b> and the flag <b>kgba=0</b> requests no blank line there, but we also have <b>--blank-lines-before-subs=2</b>, then two blank lines will still be introduced before the sub.</p>
3369
3370 </li>
3371 <li><p>The introduction of blank lines does not occur if it would conflict with other input controls or code validity. For example, a blank line will not be placed within a here-doc or within a section of code marked with format skipping comments. And in general, a blank line will only be introduced at the end of a group if the next statement is a line of code.</p>
3372
3373 </li>
3374 <li><p>The count which is used to determine the group size is not the number of lines but rather the total number of keywords which are found. Individual statements with a certain leading keyword may continue on multiple lines, but if any of these lines is nested more than one level deep then that group will be ended.</p>
3375
3376 </li>
3377 <li><p>The search for groups of lines with similar leading keywords is based on the input source, not the final formatted source. Consequently, if the source code is badly formatted, it would be best to make a first formatting pass without these options.</p>
3378
3379 </li>
3380 </ul>
3381
3382 <h2 id="Styles">Styles</h2>
3383
3384 <p>A style refers to a convenient collection of existing parameters.</p>
3385
3386 <dl>
3387
3388 <dt id="gnu---gnu-style"><b>-gnu</b>, <b>--gnu-style</b></dt>
3389 <dd>
3390
3391 <p><b>-gnu</b> gives an approximation to the GNU Coding Standards (which do not apply to perl) as they are sometimes implemented. At present, this style overrides the default style with the following parameters:</p>
3392
3393 <pre><code>    -lp -bl -noll -pt=2 -bt=2 -sbt=2 -icp</code></pre>
3394
3395 <p>To use this style with <b>-xlp</b> instead of <b>-lp</b> use <b>-gnu -xlp</b>.</p>
3396
3397 </dd>
3398 <dt id="pbp---perl-best-practices"><b>-pbp</b>, <b>--perl-best-practices</b></dt>
3399 <dd>
3400
3401 <p><b>-pbp</b> is an abbreviation for the parameters in the book <b>Perl Best Practices</b> by Damian Conway:</p>
3402
3403 <pre><code>    -l=78 -i=4 -ci=4 -st -se -vt=2 -cti=0 -pt=1 -bt=1 -sbt=1 -bbt=1 -nsfs -nolq
3404     -wbb=&quot;% + - * / x != == &gt;= &lt;= =~ !~ &lt; &gt; | &amp; =
3405           **= += *= &amp;= &lt;&lt;= &amp;&amp;= -= /= |= &gt;&gt;= ||= //= .= %= ^= x=&quot;</code></pre>
3406
3407 <p>Please note that this parameter set includes -st and -se flags, which make perltidy act as a filter on one file only. These can be overridden by placing <b>-nst</b> and/or <b>-nse</b> after the -pbp parameter.</p>
3408
3409 <p>Also note that the value of continuation indentation, -ci=4, is equal to the value of the full indentation, -i=4. It is recommended that the either (1) the parameter <b>-ci=2</b> be used instead, or (2) the flag <b>-xci</b> be set. This will help show structure, particularly when there are ternary statements. The following snippet illustrates these options.</p>
3410
3411 <pre><code>    # perltidy -pbp
3412     $self-&gt;{_text} = (
3413          !$section        ? &#39;&#39;
3414         : $type eq &#39;item&#39; ? &quot;the $section entry&quot;
3415         :                   &quot;the section on $section&quot;
3416         )
3417         . (
3418         $page
3419         ? ( $section ? &#39; in &#39; : &#39;&#39; ) . &quot;the $page$page_ext manpage&quot;
3420         : &#39; elsewhere in this document&#39;
3421         );
3422
3423     # perltidy -pbp -ci=2
3424     $self-&gt;{_text} = (
3425          !$section        ? &#39;&#39;
3426         : $type eq &#39;item&#39; ? &quot;the $section entry&quot;
3427         :                   &quot;the section on $section&quot;
3428       )
3429       . (
3430         $page
3431         ? ( $section ? &#39; in &#39; : &#39;&#39; ) . &quot;the $page$page_ext manpage&quot;
3432         : &#39; elsewhere in this document&#39;
3433       );
3434
3435     # perltidy -pbp -xci
3436     $self-&gt;{_text} = (
3437          !$section        ? &#39;&#39;
3438         : $type eq &#39;item&#39; ? &quot;the $section entry&quot;
3439         :                   &quot;the section on $section&quot;
3440         )
3441         . ( $page
3442             ? ( $section ? &#39; in &#39; : &#39;&#39; ) . &quot;the $page$page_ext manpage&quot;
3443             : &#39; elsewhere in this document&#39;
3444         );</code></pre>
3445
3446 <p>The <b>-xci</b> flag was developed after the <b>-pbp</b> parameters were published so you need to include it separately.</p>
3447
3448 </dd>
3449 </dl>
3450
3451 <h2 id="One-Line-Blocks">One-Line Blocks</h2>
3452
3453 <p>A one-line block is a block of code where the contents within the curly braces is short enough to fit on a single line. For example,</p>
3454
3455 <pre><code>    if ( -e $file ) { print &quot;&#39;$file&#39; exists\n&quot; }</code></pre>
3456
3457 <p>The alternative, a block which spans multiple lines, is said to be a broken block. With few exceptions, perltidy retains existing one-line blocks, if it is possible within the line-length constraint, but it does not attempt to form new ones. In other words, perltidy will try to follow the input file regarding broken and unbroken blocks.</p>
3458
3459 <p>The main exception to this rule is that perltidy will attempt to form new one-line blocks following the keywords <code>map</code>, <code>eval</code>, and <code>sort</code>, <code>eval</code>, because these code blocks are often small and most clearly displayed in a single line. This behavior can be controlled with the flag <b>--one-line-block-exclusion-list</b> described below.</p>
3460
3461 <p>When the <b>cuddled-else</b> style is used, the default treatment of one-line blocks may interfere with the cuddled style. In this case, the default behavior may be changed with the flag <b>--cuddled-break-option=n</b> described elsehwere.</p>
3462
3463 <p>When an existing one-line block is longer than the maximum line length, and must therefore be broken into multiple lines, perltidy checks for and adds any optional terminating semicolon (unless the <b>-nasc</b> option is used) if the block is a code block.</p>
3464
3465 <dl>
3466
3467 <dt id="olbxl-s---one-line-block-exclusion-list-s"><b>-olbxl=s</b>, <b>--one-line-block-exclusion-list=s</b></dt>
3468 <dd>
3469
3470 <p>As noted above, perltidy will, by default, attempt to create new one-line blocks for certain block types. This flag allows the user to prevent this behavior for the block types listed in the string <b>s</b>. The list <b>s</b> may include any of the words <code>sort</code>, <code>map</code>, <code>grep</code>, <code>eval</code>, or it may be <code>*</code> to indicate all of these.</p>
3471
3472 <p>So for example to prevent multi-line <b>eval</b> blocks from becoming one-line blocks, the command would be <b>-olbxl=&#39;eval&#39;</b>. In this case, existing one-line <b>eval</b> blocks will remain on one-line if possible, and existing multi-line <b>eval</b> blocks will remain multi-line blocks.</p>
3473
3474 </dd>
3475 <dt id="olbn-n---one-line-block-nesting-n"><b>-olbn=n</b>, <b>--one-line-block-nesting=n</b></dt>
3476 <dd>
3477
3478 <p>Nested one-line blocks are lines with code blocks which themselves contain code blocks. For example, the following line is a nested one-line block.</p>
3479
3480 <pre><code>         foreach (@list) { if ($_ eq $asked_for) { last } ++$found }</code></pre>
3481
3482 <p>The default behavior is to break such lines into multiple lines, but this behavior can be controlled with this flag. The values of n are:</p>
3483
3484 <pre><code>  n=0 break nested one-line blocks into multiple lines [DEFAULT]
3485   n=1 stable: keep existing nested-one line blocks intact</code></pre>
3486
3487 <p>For the above example, the default formatting (<b>-olbn=0</b>) is</p>
3488
3489 <pre><code>    foreach (@list) {
3490         if ( $_ eq $asked_for ) { last }
3491         ++$found;
3492     }</code></pre>
3493
3494 <p>If the parameter <b>-olbn=1</b> is given, then the line will be left intact if it is a single line in the source, or it will be broken into multiple lines if it is broken in multiple lines in the source.</p>
3495
3496 </dd>
3497 <dt id="olbs-n---one-line-block-semicolons-n"><b>-olbs=n</b>, <b>--one-line-block-semicolons=n</b></dt>
3498 <dd>
3499
3500 <p>This flag controls the placement of semicolons at the end of one-line blocks. Semicolons are optional before a closing block brace, and frequently they are omitted at the end of a one-line block containing just a single statement. By default, perltidy follows the input file regarding these semicolons, but this behavior can be controlled by this flag. The values of n are:</p>
3501
3502 <pre><code>  n=0 remove terminal semicolons in one-line blocks having a single statement
3503   n=1 stable; keep input file placement of terminal semicolons [DEFAULT ]
3504   n=2 add terminal semicolons in all one-line blocks</code></pre>
3505
3506 <p>Note that the <b>n=2</b> option has no effect if adding semicolons is prohibited with the <b>-nasc</b> flag. Also not that while <b>n=2</b> adds missing semicolons to all one-line blocks, regardless of complexity, the <b>n=0</b> option only removes ending semicolons which terminate one-line blocks containing just one semicolon. So these two options are not exact inverses.</p>
3507
3508 </dd>
3509 <dt id="Forming-new-one-line-blocks"><b>Forming new one-line blocks</b></dt>
3510 <dd>
3511
3512 <p>Sometimes it might be desirable to convert a script to have one-line blocks whenever possible. Although there is currently no flag for this, a simple workaround is to execute perltidy twice, once with the flag <b>-noadd-newlines</b> and then once again with normal parameters, like this:</p>
3513
3514 <pre><code>     cat infile | perltidy -nanl | perltidy &gt;outfile</code></pre>
3515
3516 <p>When executed on this snippet</p>
3517
3518 <pre><code>    if ( $? == -1 ) {
3519         die &quot;failed to execute: $!\n&quot;;
3520     }
3521     if ( $? == -1 ) {
3522         print &quot;Had enough.\n&quot;;
3523         die &quot;failed to execute: $!\n&quot;;
3524     }</code></pre>
3525
3526 <p>the result is</p>
3527
3528 <pre><code>    if ( $? == -1 ) { die &quot;failed to execute: $!\n&quot;; }
3529     if ( $? == -1 ) {
3530         print &quot;Had enough.\n&quot;;
3531         die &quot;failed to execute: $!\n&quot;;
3532     }</code></pre>
3533
3534 <p>This shows that blocks with a single statement become one-line blocks.</p>
3535
3536 </dd>
3537 <dt id="Breaking-existing-one-line-blocks"><b>Breaking existing one-line blocks</b></dt>
3538 <dd>
3539
3540 <p>There is no automatic way to break existing long one-line blocks into multiple lines, but this can be accomplished by processing a script, or section of a script, with a short value of the parameter <b>maximum-line-length=n</b>. Then, when the script is reformatted again with the normal parameters, the blocks which were broken will remain broken (with the exceptions noted above).</p>
3541
3542 <p>Another trick for doing this for certain block types is to format one time with the <b>-cuddled-else</b> flag and <b>--cuddled-break-option=2</b>. Then format again with the normal parameters. This will break any one-line blocks which are involved in a cuddled-else style.</p>
3543
3544 </dd>
3545 </dl>
3546
3547 <h2 id="Controlling-Vertical-Alignment">Controlling Vertical Alignment</h2>
3548
3549 <p>Vertical alignment refers to lining up certain symbols in a list of consecutive similar lines to improve readability. For example, the &quot;fat commas&quot; are aligned in the following statement:</p>
3550
3551 <pre><code>        $data = $pkg-&gt;new(
3552             PeerAddr =&gt; join( &quot;.&quot;, @port[ 0 .. 3 ] ),
3553             PeerPort =&gt; $port[4] * 256 + $port[5],
3554             Proto    =&gt; &#39;tcp&#39;
3555         );</code></pre>
3556
3557 <p>Vertical alignment can be completely turned off using the <b>-novalign</b> flag mentioned below. However, vertical alignment can be forced to stop and restart by selectively introducing blank lines. For example, a blank has been inserted in the following code to keep somewhat similar things aligned.</p>
3558
3559 <pre><code>    %option_range = (
3560         &#39;format&#39;             =&gt; [ &#39;tidy&#39;, &#39;html&#39;, &#39;user&#39; ],
3561         &#39;output-line-ending&#39; =&gt; [ &#39;dos&#39;,  &#39;win&#39;,  &#39;mac&#39;, &#39;unix&#39; ],
3562         &#39;character-encoding&#39; =&gt; [ &#39;none&#39;, &#39;utf8&#39; ],
3563
3564         &#39;block-brace-tightness&#39;    =&gt; [ 0, 2 ],
3565         &#39;brace-tightness&#39;          =&gt; [ 0, 2 ],
3566         &#39;paren-tightness&#39;          =&gt; [ 0, 2 ],
3567         &#39;square-bracket-tightness&#39; =&gt; [ 0, 2 ],
3568     );</code></pre>
3569
3570 <p>Vertical alignment is implemented by locally increasing an existing blank space to produce alignment with an adjacent line. It cannot occur if there is no blank space to increase. So if a particular space is removed by one of the existing controls then vertical alignment cannot occur. Likewise, if a space is added with one of the controls, then vertical alignment might occur.</p>
3571
3572 <p>For example,</p>
3573
3574 <pre><code>        # perltidy -nwls=&#39;=&gt;&#39;
3575         $data = $pkg-&gt;new(
3576             PeerAddr=&gt; join( &quot;.&quot;, @port[ 0 .. 3 ] ),
3577             PeerPort=&gt; $port[4] * 256 + $port[5],
3578             Proto=&gt; &#39;tcp&#39;
3579         );</code></pre>
3580
3581 <dl>
3582
3583 <dt id="Completely-turning-off-vertical-alignment-with--novalign"><b>Completely turning off vertical alignment with -novalign</b></dt>
3584 <dd>
3585
3586 <p>The default is to use vertical alignment, but vertical alignment can be completely turned of with the <b>-novalign</b> flag.</p>
3587
3588 <p>A lower level of control of vertical alignment is possible with three parameters <b>-vc</b>, <b>-vsc</b>, and <b>-vbc</b>. These independently control alignment of code, side comments and block comments. They are described in the next section.</p>
3589
3590 <p>The parameter <b>-valign</b> is in fact an alias for <b>-vc -vsc -vbc</b>, and its negative <b>-novalign</b> is an alias for <b>-nvc -nvsc -nvbc</b>.</p>
3591
3592 </dd>
3593 <dt id="Controlling-code-alignment-with---valign-code-or--vc"><b>Controlling code alignment with --valign-code or -vc</b></dt>
3594 <dd>
3595
3596 <p>The <b>-vc</b> flag enables alignment of code symbols such as <b>=</b>. The default is <b>-vc</b>. For detailed control of which symbols to align, see the <b>-valign-exclude-list</b> parameter below.</p>
3597
3598 </dd>
3599 <dt id="Controlling-side-comment-alignment-with---valign-side-comments-or--vsc"><b>Controlling side comment alignment with --valign-side-comments or -vsc</b></dt>
3600 <dd>
3601
3602 <p>The <b>-vsc</b> flag enables alignment of side comments and is enabled by default. If side comment alignment is disabled with <b>-nvsc</b> they will appear at a fixed space from the preceding code token. The default is <b>-vsc</b></p>
3603
3604 </dd>
3605 <dt id="Controlling-block-comment-alignment-with---valign-block-comments-or--vbc"><b>Controlling block comment alignment with --valign-block-comments or -vbc</b></dt>
3606 <dd>
3607
3608 <p>When <b>-vbc</b> is enabled, block comments can become aligned for example if one comment of a consecutive sequence of comments becomes outdented due a length in excess of the maximum line length. If this occurs, the entire group of comments will remain aligned and be outdented by the same amount. This coordinated alignment will not occur if <b>-nvbc</b> is set. The default is <b>-vbc</b>.</p>
3609
3610 </dd>
3611 <dt id="Finer-alignment-control-with---valign-exclusion-list-s-or--vxl-s-and---valign-inclusion-list-s-or--vil-s"><b>Finer alignment control with --valign-exclusion-list=s or -vxl=s and --valign-inclusion-list=s or -vil=s</b></dt>
3612 <dd>
3613
3614 <p>More detailed control of alignment types is available with these two parameters. Most of the vertical alignments in typical programs occur at one of the tokens &#39;,&#39;, &#39;=&#39;, and &#39;=&gt;&#39;, but many other alignments are possible and are given in the following list:</p>
3615
3616 <pre><code>  = **= += *= &amp;= &lt;&lt;= &amp;&amp;= -= /= |= &gt;&gt;= ||= //= .= %= ^= x=
3617   { ( ? : , ; =&gt; &amp;&amp; || ~~ !~~ =~ !~ // &lt;=&gt; -&gt; q
3618   if unless and or err for foreach while until</code></pre>
3619
3620 <p>These alignment types correspond to perl symbols, operators and keywords except for &#39;q&#39;, which refers to the special case of alignment in a &#39;use&#39; statement of qw quotes and empty parens.</p>
3621
3622 <p>They are all enabled by default, but they can be selectively disabled by including one or more of these tokens in the space-separated list <b>valign-exclusion-list=s</b>. For example, the following would prevent alignment at <b>=</b> and <b>if</b>:</p>
3623
3624 <pre><code>  --valign-exclusion-list=&#39;= if&#39;</code></pre>
3625
3626 <p>If it is simpler to specify only the token types which are to be aligned, then include the types which are to be aligned in the list of <b>--valign-inclusion-list</b>. In that case you may leave the <b>valign-exclusion-list</b> undefined, or use the special symbol <b>*</b> for the exclusion list. For example, the following parameters enable alignment only at commas and &#39;fat commas&#39;:</p>
3627
3628 <pre><code>  --valign-inclusion-list=&#39;, =&gt;&#39;
3629   --valign-exclusion-list=&#39;*&#39;     ( this is optional and may be omitted )</code></pre>
3630
3631 <p>These parameter lists should consist of space-separated tokens from the above list of possible alignment tokens, or a &#39;*&#39;. If an unrecognized token appears, it is simply ignored. And if a specific token is entered in both lists by mistake then the exclusion list has priority.</p>
3632
3633 <p>The default values of these parameters enable all alignments and are equivalent to</p>
3634
3635 <pre><code>  --valign-exclusion-list=&#39; &#39;
3636   --valign-inclusion-list=&#39;*&#39;</code></pre>
3637
3638 <p>To illustrate, consider the following snippet with default formatting</p>
3639
3640 <pre><code>    # perltidy
3641     $co_description = ($color) ? &#39;bold cyan&#39;  : &#39;&#39;;           # description
3642     $co_prompt      = ($color) ? &#39;bold green&#39; : &#39;&#39;;           # prompt
3643     $co_unused      = ($color) ? &#39;on_green&#39;   : &#39;reverse&#39;;    # unused</code></pre>
3644
3645 <p>To exclude all alignments except the equals (i.e., include only equals) we could use:</p>
3646
3647 <pre><code>    # perltidy -vil=&#39;=&#39;
3648     $co_description = ($color) ? &#39;bold cyan&#39; : &#39;&#39;;          # description
3649     $co_prompt      = ($color) ? &#39;bold green&#39; : &#39;&#39;;         # prompt
3650     $co_unused      = ($color) ? &#39;on_green&#39; : &#39;reverse&#39;;    # unused</code></pre>
3651
3652 <p>To exclude only the equals we could use:</p>
3653
3654 <pre><code>    # perltidy -vxl=&#39;=&#39;
3655     $co_description = ($color) ? &#39;bold cyan&#39; : &#39;&#39;;     # description
3656     $co_prompt = ($color) ? &#39;bold green&#39; : &#39;&#39;;         # prompt
3657     $co_unused = ($color) ? &#39;on_green&#39; : &#39;reverse&#39;;    # unused</code></pre>
3658
3659 <p>Notice in this last example that although only the equals alignment was excluded, the ternary alignments were also lost. This happens because the vertical aligner sweeps from left-to-right and usually stops if an important alignment cannot be made for some reason.</p>
3660
3661 <p>But also notice that side comments remain aligned because their alignment is controlled separately with the parameter <b>--valign-side_comments</b> described above.</p>
3662
3663 </dd>
3664 </dl>
3665
3666 <h2 id="Extended-Syntax">Extended Syntax</h2>
3667
3668 <p>This section describes some parameters for dealing with extended syntax.</p>
3669
3670 <p>For another method of handling extended syntax see the section <a href="#Skipping-Selected-Sections-of-Code">&quot;Skipping Selected Sections of Code&quot;</a>.</p>
3671
3672 <p>Also note that the module <i>Perl::Tidy</i> supplies a pre-filter and post-filter capability. This requires calling the module from a separate program rather than through the binary <i>perltidy</i>.</p>
3673
3674 <dl>
3675
3676 <dt id="xs---extended-syntax"><b>-xs</b>, <b>--extended-syntax</b></dt>
3677 <dd>
3678
3679 <p>This flag allows perltidy to handle certain common extensions to the standard syntax without complaint.</p>
3680
3681 <p>For example, without this flag a structure such as the following would generate a syntax error:</p>
3682
3683 <pre><code>    Method deposit( Num $amount) {
3684         $self-&gt;balance( $self-&gt;balance + $amount );
3685     }</code></pre>
3686
3687 <p>This flag is enabled by default but it can be deactivated with <b>-nxs</b>. Probably the only reason to deactivate this flag is to generate more diagnostic messages when debugging a script.</p>
3688
3689 </dd>
3690 <dt id="sal-s---sub-alias-list-s"><b>-sal=s</b>, <b>--sub-alias-list=s</b></dt>
3691 <dd>
3692
3693 <p>This flag causes one or more words to be treated the same as if they were the keyword <b>sub</b>. The string <b>s</b> contains one or more alias words, separated by spaces or commas.</p>
3694
3695 <p>For example,</p>
3696
3697 <pre><code>        perltidy -sal=&#39;method fun _sub M4&#39;</code></pre>
3698
3699 <p>will cause the perltidy to treat the words &#39;method&#39;, &#39;fun&#39;, &#39;_sub&#39; and &#39;M4&#39; the same as if they were &#39;sub&#39;. Note that if the alias words are separated by spaces then the string of words should be placed in quotes.</p>
3700
3701 <p>Note that several other parameters accept a list of keywords, including &#39;sub&#39; (see <a href="#Specifying-Block-Types">&quot;Specifying Block Types&quot;</a>). You do not need to include any sub aliases in these lists. Just include keyword &#39;sub&#39; if you wish, and all aliases are automatically included.</p>
3702
3703 </dd>
3704 <dt id="gal-s---grep-alias-list-s"><b>-gal=s</b>, <b>--grep-alias-list=s</b></dt>
3705 <dd>
3706
3707 <p>This flag allows a code block following an external &#39;list operator&#39; function to be formatted as if it followed one of the built-in keywords <b>grep</b>, <b>map</b> or <b>sort</b>. The string <b>s</b> contains the names of one or more such list operators, separated by spaces or commas.</p>
3708
3709 <p>By &#39;list operator&#39; is meant a function which is invoked in the form</p>
3710
3711 <pre><code>      word {BLOCK} @list</code></pre>
3712
3713 <p>Perltidy tries to keep code blocks for these functions intact, since they are usually short, and does not automatically break after the closing brace since a list may follow. It also does some special handling of continuation indentation.</p>
3714
3715 <p>For example, the code block arguments to functions &#39;My_grep&#39; and &#39;My_map&#39; can be given formatting like &#39;grep&#39; with</p>
3716
3717 <pre><code>        perltidy -gal=&#39;My_grep My_map&#39;</code></pre>
3718
3719 <p>By default, the following list operators in List::Util are automatically included:</p>
3720
3721 <pre><code>      all any first none notall reduce reductions</code></pre>
3722
3723 <p>Any operators specified with <b>--grep-alias-list</b> are added to this list. The next parameter can be used to remove words from this default list.</p>
3724
3725 </dd>
3726 <dt id="gaxl-s---grep-alias-exclusion-list-s"><b>-gaxl=s</b>, <b>--grep-alias-exclusion-list=s</b></dt>
3727 <dd>
3728
3729 <p>The <b>-gaxl=s</b> flag provides a method for removing any of the default list operators given above by listing them in the string <b>s</b>. To remove all of the default operators use <b>-gaxl=&#39;*&#39;</b>.</p>
3730
3731 </dd>
3732 <dt id="uf-s---use-feature-s"><b>-uf=s</b>, <b>--use-feature=s</b></dt>
3733 <dd>
3734
3735 <p>This flag tells perltidy to allow the syntax associated a pragma in string <b>s</b>. Currently only the recognized values for the string are <b>s=&#39;class&#39;</b> or string <b>s=&#39; &#39;</b>. The default is <b>--use-feature=&#39;class&#39;</b>. This enables perltidy to recognized the special words <b>class</b>, <b>method</b>, <b>field</b>, and <b>ADJUST</b>. If this causes a conflict with other uses of these words, the default can be turned off with <b>--use-feature=&#39; &#39;</b>.</p>
3736
3737 </dd>
3738 </dl>
3739
3740 <h2 id="Other-Controls">Other Controls</h2>
3741
3742 <dl>
3743
3744 <dt id="Deleting-selected-text"><b>Deleting selected text</b></dt>
3745 <dd>
3746
3747 <p>Perltidy can selectively delete comments and/or pod documentation. The command <b>-dac</b> or <b>--delete-all-comments</b> will delete all comments <b>and</b> all pod documentation, leaving just code and any leading system control lines.</p>
3748
3749 <p>The command <b>-dp</b> or <b>--delete-pod</b> will remove all pod documentation (but not comments).</p>
3750
3751 <p>Two commands which remove comments (but not pod) are: <b>-dbc</b> or <b>--delete-block-comments</b> and <b>-dsc</b> or <b>--delete-side-comments</b>. (Hanging side comments will be deleted with side comments here.)</p>
3752
3753 <p>When side comments are deleted, any special control side comments for non-indenting braces will be retained unless they are deactivated with a <b>-nnib</b> flag.</p>
3754
3755 <p>The negatives of these commands also work, and are the defaults. When block comments are deleted, any leading &#39;hash-bang&#39; will be retained. Also, if the <b>-x</b> flag is used, any system commands before a leading hash-bang will be retained (even if they are in the form of comments).</p>
3756
3757 </dd>
3758 <dt id="Writing-selected-text-to-a-file"><b>Writing selected text to a file</b></dt>
3759 <dd>
3760
3761 <p>When perltidy writes a formatted text file, it has the ability to also send selected text to a file with a <i>.TEE</i> extension. This text can include comments and pod documentation.</p>
3762
3763 <p>The command <b>-tac</b> or <b>--tee-all-comments</b> will write all comments <b>and</b> all pod documentation.</p>
3764
3765 <p>The command <b>-tp</b> or <b>--tee-pod</b> will write all pod documentation (but not comments).</p>
3766
3767 <p>The commands which write comments (but not pod) are: <b>-tbc</b> or <b>--tee-block-comments</b> and <b>-tsc</b> or <b>--tee-side-comments</b>. (Hanging side comments will be written with side comments here.)</p>
3768
3769 <p>The negatives of these commands also work, and are the defaults.</p>
3770
3771 </dd>
3772 <dt id="Using-a-.perltidyrc-command-file"><b>Using a <i>.perltidyrc</i> command file</b></dt>
3773 <dd>
3774
3775 <p>If you use perltidy frequently, you probably won&#39;t be happy until you create a <i>.perltidyrc</i> file to avoid typing commonly-used parameters. Perltidy will first look in your current directory for a command file named <i>.perltidyrc</i>. If it does not find one, it will continue looking for one in other standard locations.</p>
3776
3777 <p>These other locations are system-dependent, and may be displayed with the command <code>perltidy -dpro</code>. Under Unix systems, it will first look for an environment variable <b>PERLTIDY</b>. Then it will look for a <i>.perltidyrc</i> file in the home directory, and then for a system-wide file <i>/usr/local/etc/perltidyrc</i>, and then it will look for <i>/etc/perltidyrc</i>. Note that these last two system-wide files do not have a leading dot. Further system-dependent information will be found in the INSTALL file distributed with perltidy.</p>
3778
3779 <p>Under Windows, perltidy will also search for a configuration file named <i>perltidy.ini</i> since Windows does not allow files with a leading period (.). Use <code>perltidy -dpro</code> to see the possible locations for your system. An example might be <i>C:\Documents and Settings\All Users\perltidy.ini</i>.</p>
3780
3781 <p>Another option is the use of the PERLTIDY environment variable. The method for setting environment variables depends upon the version of Windows that you are using. Instructions for Windows 95 and later versions can be found here:</p>
3782
3783 <p>http://www.netmanage.com/000/20021101_005_tcm21-6336.pdf</p>
3784
3785 <p>Under Windows NT / 2000 / XP the PERLTIDY environment variable can be placed in either the user section or the system section. The later makes the configuration file common to all users on the machine. Be sure to enter the full path of the configuration file in the value of the environment variable. Ex. PERLTIDY=C:\Documents and Settings\perltidy.ini</p>
3786
3787 <p>The configuration file is free format, and simply a list of parameters, just as they would be entered on a command line. Any number of lines may be used, with any number of parameters per line, although it may be easiest to read with one parameter per line. Comment text begins with a #, and there must also be a space before the # for side comments. It is a good idea to put complex parameters in either single or double quotes.</p>
3788
3789 <p>Here is an example of a <i>.perltidyrc</i> file:</p>
3790
3791 <pre><code>  # This is a simple of a .perltidyrc configuration file
3792   # This implements a highly spaced style
3793   -se    # errors to standard error output
3794   -w     # show all warnings
3795   -bl    # braces on new lines
3796   -pt=0  # parens not tight at all
3797   -bt=0  # braces not tight
3798   -sbt=0 # square brackets not tight</code></pre>
3799
3800 <p>The parameters in the <i>.perltidyrc</i> file are installed first, so any parameters given on the command line will have priority over them.</p>
3801
3802 <p>To avoid confusion, perltidy ignores any command in the .perltidyrc file which would cause some kind of dump and an exit. These are:</p>
3803
3804 <pre><code> -h -v -ddf -dln -dop -dsn -dtt -dwls -dwrs -ss</code></pre>
3805
3806 <p>There are several options may be helpful in debugging a <i>.perltidyrc</i> file:</p>
3807
3808 <ul>
3809
3810 <li><p>A very helpful command is <b>--dump-profile</b> or <b>-dpro</b>. It writes a list of all configuration filenames tested to standard output, and if a file is found, it dumps the content to standard output before exiting. So, to find out where perltidy looks for its configuration files, and which one if any it selects, just enter</p>
3811
3812 <pre><code>  perltidy -dpro</code></pre>
3813
3814 </li>
3815 <li><p>It may be simplest to develop and test configuration files with alternative names, and invoke them with <b>-pro=filename</b> on the command line. Then rename the desired file to <i>.perltidyrc</i> when finished.</p>
3816
3817 </li>
3818 <li><p>The parameters in the <i>.perltidyrc</i> file can be switched off with the <b>-npro</b> option.</p>
3819
3820 </li>
3821 <li><p>The commands <b>--dump-options</b>, <b>--dump-defaults</b>, <b>--dump-long-names</b>, and <b>--dump-short-names</b>, all described below, may all be helpful.</p>
3822
3823 </li>
3824 </ul>
3825
3826 </dd>
3827 <dt id="Creating-a-new-abbreviation"><b>Creating a new abbreviation</b></dt>
3828 <dd>
3829
3830 <p>A special notation is available for use in a <i>.perltidyrc</i> file for creating an abbreviation for a group of options. This can be used to create a shorthand for one or more styles which are frequently, but not always, used. The notation is to group the options within curly braces which are preceded by the name of the alias (without leading dashes), like this:</p>
3831
3832 <pre><code>        newword {
3833         -opt1
3834         -opt2
3835         }</code></pre>
3836
3837 <p>where <b>newword</b> is the abbreviation, and <b>opt1</b>, etc, are existing parameters <i>or other abbreviations</i>. The main syntax requirement is that the new abbreviation along with its opening curly brace must begin on a new line. Space before and after the curly braces is optional.</p>
3838
3839 <p>For a specific example, the following line</p>
3840
3841 <pre><code>        oneliner { --maximum-line-length=0 --noadd-newlines --noadd-terminal-newline}</code></pre>
3842
3843 <p>or equivalently with abbreviations</p>
3844
3845 <pre><code>        oneliner { -l=0 -nanl -natnl }</code></pre>
3846
3847 <p>could be placed in a <i>.perltidyrc</i> file to temporarily override the maximum line length with a large value, to temporarily prevent new line breaks from being added, and to prevent an extra newline character from being added the file. All other settings in the <i>.perltidyrc</i> file still apply. Thus it provides a way to format a long &#39;one liner&#39; when perltidy is invoked with</p>
3848
3849 <pre><code>        perltidy --oneliner ...</code></pre>
3850
3851 <p>(Either <code>-oneliner</code> or <code>--oneliner</code> may be used).</p>
3852
3853 </dd>
3854 <dt id="Skipping-leading-non-perl-commands-with--x-or---look-for-hash-bang">Skipping leading non-perl commands with <b>-x</b> or <b>--look-for-hash-bang</b></dt>
3855 <dd>
3856
3857 <p>If your script has leading lines of system commands or other text which are not valid perl code, and which are separated from the start of the perl code by a &quot;hash-bang&quot; line, ( a line of the form <code>#!...perl</code> ), you must use the <b>-x</b> flag to tell perltidy not to parse and format any lines before the &quot;hash-bang&quot; line. This option also invokes perl with a -x flag when checking the syntax. This option was originally added to allow perltidy to parse interactive VMS scripts, but it should be used for any script which is normally invoked with <code>perl -x</code>.</p>
3858
3859 <p>Please note: do not use this flag unless you are sure your script needs it. Parsing errors can occur if it does not have a hash-bang, or, for example, if the actual first hash-bang is in a here-doc. In that case a parsing error will occur because the tokenization will begin in the middle of the here-doc.</p>
3860
3861 </dd>
3862 <dt id="Making-a-file-unreadable"><b>Making a file unreadable</b></dt>
3863 <dd>
3864
3865 <p>The goal of perltidy is to improve the readability of files, but there are two commands which have the opposite effect, <b>--mangle</b> and <b>--extrude</b>. They are actually merely aliases for combinations of other parameters. Both of these strip all possible whitespace, but leave comments and pod documents, so that they are essentially reversible. The difference between these is that <b>--mangle</b> puts the fewest possible line breaks in a script while <b>--extrude</b> puts the maximum possible. Note that these options do not provided any meaningful obfuscation, because perltidy can be used to reformat the files. They were originally developed to help test the tokenization logic of perltidy, but they have other uses. One use for <b>--mangle</b> is the following:</p>
3866
3867 <pre><code>  perltidy --mangle myfile.pl -st | perltidy -o myfile.pl.new</code></pre>
3868
3869 <p>This will form the maximum possible number of one-line blocks (see next section), and can sometimes help clean up a badly formatted script.</p>
3870
3871 <p>A similar technique can be used with <b>--extrude</b> instead of <b>--mangle</b> to make the minimum number of one-line blocks.</p>
3872
3873 <p>Another use for <b>--mangle</b> is to combine it with <b>-dac</b> to reduce the file size of a perl script.</p>
3874
3875 </dd>
3876 <dt id="Debugging"><b>Debugging</b></dt>
3877 <dd>
3878
3879 <p>The following flags are available for debugging:</p>
3880
3881 <p><b>--dump-cuddled-block-list</b> or <b>-dcbl</b> will dump to standard output the internal hash of cuddled block types created by a <b>-cuddled-block-list</b> input string.</p>
3882
3883 <p><b>--dump-defaults</b> or <b>-ddf</b> will write the default option set to standard output and quit</p>
3884
3885 <p><b>--dump-profile</b> or <b>-dpro</b> will write the name of the current configuration file and its contents to standard output and quit.</p>
3886
3887 <p><b>--dump-options</b> or <b>-dop</b> will write current option set to standard output and quit.</p>
3888
3889 <p><b>--dump-long-names</b> or <b>-dln</b> will write all command line long names (passed to Get_options) to standard output and quit.</p>
3890
3891 <p><b>--dump-short-names</b> or <b>-dsn</b> will write all command line short names to standard output and quit.</p>
3892
3893 <p><b>--dump-token-types</b> or <b>-dtt</b> will write a list of all token types to standard output and quit.</p>
3894
3895 <p><b>--dump-want-left-space</b> or <b>-dwls</b> will write the hash %want_left_space to standard output and quit. See the section on controlling whitespace around tokens.</p>
3896
3897 <p><b>--dump-want-right-space</b> or <b>-dwrs</b> will write the hash %want_right_space to standard output and quit. See the section on controlling whitespace around tokens.</p>
3898
3899 <p><b>--no-memoize</b> or <b>-nmem</b> will turn of memoizing. Memoization can reduce run time when running perltidy repeatedly in a single process. It is on by default but can be deactivated for testing with <b>-nmem</b>.</p>
3900
3901 <p><b>--no-timestamp</b> or <b>-nts</b> will eliminate any time stamps in output files to prevent differences in dates from causing test installation scripts to fail. There are just a couple of places where timestamps normally occur. One is in the headers of html files, and another is when the <b>-cscw</b> option is selected. The default is to allow timestamps (<b>--timestamp</b> or <b>-ts</b>).</p>
3902
3903 <p><b>--file-size-order</b> or <b>-fso</b> will cause files to be processed in order of increasing size, when multiple files are being processed. This is useful during program development, when large numbers of files with varying sizes are processed, because it can reduce virtual memory usage.</p>
3904
3905 <p><b>--maximum-file-size-mb=n</b> or <b>-maxfs=n</b> specifies the maximum file size in megabytes that perltidy will attempt to format. This parameter is provided to avoid causing system problems by accidentally attempting to format an extremely large data file. Most perl scripts are less than about 2 MB in size. The integer <b>n</b> has a default value of 10, so perltidy will skip formatting files which have a size greater than 10 MB. The command to increase the limit to 20 MB for example would be</p>
3906
3907 <pre><code>  perltidy -maxfs=20</code></pre>
3908
3909 <p>This only applies to files specified by filename on the command line.</p>
3910
3911 <p><b>--maximum-level-errors=n</b> or <b>-maxle=n</b> specifies the maximum number of indentation level errors are allowed before perltidy skips formatting and just outputs a file verbatim. The default is <b>n=1</b>. This means that if the final indentation of a script differs from the starting indentation by more than 1 levels, the file will be output verbatim. To avoid formatting if there are any indentation level errors use -maxle=0. To skip this check you can either set n equal to a large number, such as <b>n=100</b>, or set <b>n=-1</b>.</p>
3912
3913 <p>For example, the following script has level error of 3 and will be output verbatim</p>
3914
3915 <pre><code>    Input and default output:
3916     {{{
3917
3918
3919     perltidy -maxle=100
3920     {
3921         {
3922             {</code></pre>
3923
3924 <p><b>--maximum-unexpected-errors=n</b> or <b>-maxue=n</b> specifies the maximum number of unexpected tokenization errors are allowed before formatting is skipped and a script is output verbatim. The intention is to avoid accidentally formatting a non-perl script, such as an html file for example. This check can be turned off by setting <b>n=0</b>.</p>
3925
3926 <p>A recommended value is <b>n=3</b>. However, the default is <b>n=0</b> (skip this check) to avoid causing problems with scripts which have extended syntaxes.</p>
3927
3928 <p><b>-DEBUG</b> will write a file with extension <i>.DEBUG</i> for each input file showing the tokenization of all lines of code.</p>
3929
3930 </dd>
3931 <dt id="Making-a-table-of-information-on-code-blocks"><b>Making a table of information on code blocks</b></dt>
3932 <dd>
3933
3934 <p>A table listing information about the blocks of code in a file can be made with <b>--dump-block-summary</b>, or <b>-dbs</b>. This causes perltidy to read and parse the file, write a table of comma-separated values for selected code blocks to the standard output, and then exit. This parameter must be on the command line, not in a <i>.perlticyrc</i> file, and it requires a single file name on the command line. For example</p>
3935
3936 <pre><code>   perltidy -dbs somefile.pl &gt;blocks.csv</code></pre>
3937
3938 <p>produces an output file <i>blocks.csv</i> whose lines hold these parameters:</p>
3939
3940 <pre><code>    filename     - the name of the file
3941     line         - the line number of the opening brace of this block
3942     line_count   - the number of lines between opening and closing braces
3943     code_lines   - the number of lines excluding blanks, comments, and pod
3944     type         - the block type (sub, for, foreach, ...)
3945     name         - the block name if applicable (sub name, label, asub name)
3946     depth        - the nesting depth of the opening block brace
3947     max_change   - the change in depth to the most deeply nested code block
3948     block_count  - the total number of code blocks nested in this block
3949     mccabe_count - the McCabe complexity measure of this code block</code></pre>
3950
3951 <p>This feature was developed to help identify complex sections of code as an aid in refactoring. The McCabe complexity measure follows the definition used by Perl::Critic. By default the table contains these values for subroutines, but the user may request them for any or all blocks of code or packages. For blocks which are loops nested within loops, a postfix &#39;+&#39; to the <code>type</code> is added to indicate possible code complexity. Although the table does not otherwise indicate which blocks are nested in other blocks, this can be determined by computing and comparing the block ending line numbers.</p>
3952
3953 <p>By default the table lists subroutines with more than 20 <code>code_lines</code>, but this can be changed with the following two parameters:</p>
3954
3955 <p><b>--dump-block-minimum-lines=n</b>, or <b>-dbl=n</b>, where <b>n</b> is the minimum number of <code>code_lines</code> to be included. The default is <b>-n=20</b>. Note that <code>code_lines</code> is the number of lines excluding and comments, blanks and pod.</p>
3956
3957 <p><b>--dump-block-types=s</b>, or <b>-dbt=s</b>, where string <b>s</b> is a list of block types to be included. The type of a block is either the name of the perl builtin keyword for that block (such as <b>sub if elsif else for foreach ..</b>) or the word immediately before the opening brace. In addition, there are a few symbols for special block types, as follows:</p>
3958
3959 <pre><code>   if elsif else for foreach ... any keyword introducing a block
3960    sub  - any sub or anynomous sub
3961    asub - any anonymous sub
3962    *    - any block except nameless blocks
3963    +    - any nested inner block loop
3964    package - any package or class
3965    closure - any nameless block</code></pre>
3966
3967 <p>In addition, specific block loop types which are nested in other loops can be selected by adding a <b>+</b> after the block name. (Nested loops are sometimes good candidates for restructuring).</p>
3968
3969 <p>The default is <b>-dbt=&#39;sub&#39;</b>.</p>
3970
3971 <p>In the following examples a table <code>block.csv</code> is created for a file <code>somefile.pl</code>:</p>
3972
3973 <ul>
3974
3975 <li><p>This selects both <code>subs</code> and <code>packages</code> which have 20 or more lines of code. This can be useful in code which contains multiple packages.</p>
3976
3977 <pre><code>    perltidy -dbs -dbt=&#39;sub package&#39; somefile.pl &gt;blocks.csv</code></pre>
3978
3979 </li>
3980 <li><p>This selects block types <code>sub for foreach while</code> with 10 or more code lines.</p>
3981
3982 <pre><code>    perltidy -dbs -dbl=10 -dbt=&#39;sub for foreach while&#39; somefile.pl &gt;blocks.csv</code></pre>
3983
3984 </li>
3985 <li><p>This selects blocks with 2 or more code lines which are type <code>sub</code> or which are inner loops.</p>
3986
3987 <pre><code>    perltidy -dbs -dbl=2 -dbt=&#39;sub +&#39; somefile.pl &gt;blocks.csv</code></pre>
3988
3989 </li>
3990 <li><p>This selects every block and package.</p>
3991
3992 <pre><code>    perltidy -dbs -dbl=1 -dbt=&#39;* closure&#39; somefile.pl &gt;blocks.csv</code></pre>
3993
3994 </li>
3995 </ul>
3996
3997 </dd>
3998 <dt id="Working-with-MakeMaker-AutoLoader-and-SelfLoader"><b>Working with MakeMaker, AutoLoader and SelfLoader</b></dt>
3999 <dd>
4000
4001 <p>The first $VERSION line of a file which might be eval&#39;d by MakeMaker is passed through unchanged except for indentation. Use <b>--nopass-version-line</b>, or <b>-npvl</b>, to deactivate this feature.</p>
4002
4003 <p>If the AutoLoader module is used, perltidy will continue formatting code after seeing an __END__ line. Use <b>--nolook-for-autoloader</b>, or <b>-nlal</b>, to deactivate this feature.</p>
4004
4005 <p>Likewise, if the SelfLoader module is used, perltidy will continue formatting code after seeing a __DATA__ line. Use <b>--nolook-for-selfloader</b>, or <b>-nlsl</b>, to deactivate this feature.</p>
4006
4007 </dd>
4008 <dt id="Working-around-problems-with-older-version-of-Perl"><b>Working around problems with older version of Perl</b></dt>
4009 <dd>
4010
4011 <p>Perltidy contains a number of rules which help avoid known subtleties and problems with older versions of perl, and these rules always take priority over whatever formatting flags have been set. For example, perltidy will usually avoid starting a new line with a bareword, because this might cause problems if <code>use strict</code> is active.</p>
4012
4013 <p>There is no way to override these rules.</p>
4014
4015 </dd>
4016 </dl>
4017
4018 <h1 id="HTML-OPTIONS">HTML OPTIONS</h1>
4019
4020 <dl>
4021
4022 <dt id="The--html-master-switch">The <b>-html</b> master switch</dt>
4023 <dd>
4024
4025 <p>The flag <b>-html</b> causes perltidy to write an html file with extension <i>.html</i>. So, for example, the following command</p>
4026
4027 <pre><code>        perltidy -html somefile.pl</code></pre>
4028
4029 <p>will produce a syntax-colored html file named <i>somefile.pl.html</i> which may be viewed with a browser.</p>
4030
4031 <p><b>Please Note</b>: In this case, perltidy does not do any formatting to the input file, and it does not write a formatted file with extension <i>.tdy</i>. This means that two perltidy runs are required to create a fully reformatted, html copy of a script.</p>
4032
4033 </dd>
4034 <dt id="The--pre-flag-for-code-snippets">The <b>-pre</b> flag for code snippets</dt>
4035 <dd>
4036
4037 <p>When the <b>-pre</b> flag is given, only the pre-formatted section, within the &lt;PRE&gt; and &lt;/PRE&gt; tags, will be output. This simplifies inclusion of the output in other files. The default is to output a complete web page.</p>
4038
4039 </dd>
4040 <dt id="The--nnn-flag-for-line-numbering">The <b>-nnn</b> flag for line numbering</dt>
4041 <dd>
4042
4043 <p>When the <b>-nnn</b> flag is given, the output lines will be numbered.</p>
4044
4045 </dd>
4046 <dt id="The--toc-or---html-table-of-contents-flag">The <b>-toc</b>, or <b>--html-table-of-contents</b> flag</dt>
4047 <dd>
4048
4049 <p>By default, a table of contents to packages and subroutines will be written at the start of html output. Use <b>-ntoc</b> to prevent this. This might be useful, for example, for a pod document which contains a number of unrelated code snippets. This flag only influences the code table of contents; it has no effect on any table of contents produced by pod2html (see next item).</p>
4050
4051 </dd>
4052 <dt id="The--pod-or---pod2html-flag">The <b>-pod</b>, or <b>--pod2html</b> flag</dt>
4053 <dd>
4054
4055 <p>There are two options for formatting pod documentation. The default is to pass the pod through the Pod::Html module (which forms the basis of the pod2html utility). Any code sections are formatted by perltidy, and the results then merged. Note: perltidy creates a temporary file when Pod::Html is used; see <a href="#FILES">&quot;FILES&quot;</a>. Also, Pod::Html creates temporary files for its cache.</p>
4056
4057 <p>NOTE: Perltidy counts the number of <code>=cut</code> lines, and either moves the pod text to the top of the html file if there is one <code>=cut</code>, or leaves the pod text in its original order (interleaved with code) otherwise.</p>
4058
4059 <p>Most of the flags accepted by pod2html may be included in the perltidy command line, and they will be passed to pod2html. In some cases, the flags have a prefix <code>pod</code> to emphasize that they are for the pod2html, and this prefix will be removed before they are passed to pod2html. The flags which have the additional <code>pod</code> prefix are:</p>
4060
4061 <pre><code>   --[no]podheader --[no]podindex --[no]podrecurse --[no]podquiet
4062    --[no]podverbose --podflush</code></pre>
4063
4064 <p>The flags which are unchanged from their use in pod2html are:</p>
4065
4066 <pre><code>   --backlink=s --cachedir=s --htmlroot=s --libpods=s --title=s
4067    --podpath=s --podroot=s</code></pre>
4068
4069 <p>where &#39;s&#39; is an appropriate character string. Not all of these flags are available in older versions of Pod::Html. See your Pod::Html documentation for more information.</p>
4070
4071 <p>The alternative, indicated with <b>-npod</b>, is not to use Pod::Html, but rather to format pod text in italics (or whatever the stylesheet indicates), without special html markup. This is useful, for example, if pod is being used as an alternative way to write comments.</p>
4072
4073 </dd>
4074 <dt id="The--frm-or---frames-flag">The <b>-frm</b>, or <b>--frames</b> flag</dt>
4075 <dd>
4076
4077 <p>By default, a single html output file is produced. This can be changed with the <b>-frm</b> option, which creates a frame holding a table of contents in the left panel and the source code in the right side. This simplifies code browsing. Assume, for example, that the input file is <i>MyModule.pm</i>. Then, for default file extension choices, these three files will be created:</p>
4078
4079 <pre><code> MyModule.pm.html      - the frame
4080  MyModule.pm.toc.html  - the table of contents
4081  MyModule.pm.src.html  - the formatted source code</code></pre>
4082
4083 <p>Obviously this file naming scheme requires that output be directed to a real file (as opposed to, say, standard output). If this is not the case, or if the file extension is unknown, the <b>-frm</b> option will be ignored.</p>
4084
4085 </dd>
4086 <dt id="The--text-s-or---html-toc-extension-flag">The <b>-text=s</b>, or <b>--html-toc-extension</b> flag</dt>
4087 <dd>
4088
4089 <p>Use this flag to specify the extra file extension of the table of contents file when html frames are used. The default is &quot;toc&quot;. See <a href="#Specifying-File-Extensions">&quot;Specifying File Extensions&quot;</a>.</p>
4090
4091 </dd>
4092 <dt id="The--sext-s-or---html-src-extension-flag">The <b>-sext=s</b>, or <b>--html-src-extension</b> flag</dt>
4093 <dd>
4094
4095 <p>Use this flag to specify the extra file extension of the content file when html frames are used. The default is &quot;src&quot;. See <a href="#Specifying-File-Extensions">&quot;Specifying File Extensions&quot;</a>.</p>
4096
4097 </dd>
4098 <dt id="The--hent-or---html-entities-flag">The <b>-hent</b>, or <b>--html-entities</b> flag</dt>
4099 <dd>
4100
4101 <p>This flag controls the use of Html::Entities for html formatting. By default, the module Html::Entities is used to encode special symbols. This may not be the right thing for some browser/language combinations. Use --nohtml-entities or -nhent to prevent this.</p>
4102
4103 </dd>
4104 <dt id="Style-Sheets"><b>Style Sheets</b></dt>
4105 <dd>
4106
4107 <p>Style sheets make it very convenient to control and adjust the appearance of html pages. The default behavior is to write a page of html with an embedded style sheet.</p>
4108
4109 <p>An alternative to an embedded style sheet is to create a page with a link to an external style sheet. This is indicated with the <b>-css=filename</b>, where the external style sheet is <i>filename</i>. The external style sheet <i>filename</i> will be created if and only if it does not exist. This option is useful for controlling multiple pages from a single style sheet.</p>
4110
4111 <p>To cause perltidy to write a style sheet to standard output and exit, use the <b>-ss</b>, or <b>--stylesheet</b>, flag. This is useful if the style sheet could not be written for some reason, such as if the <b>-pre</b> flag was used. Thus, for example,</p>
4112
4113 <pre><code>  perltidy -html -ss &gt;mystyle.css</code></pre>
4114
4115 <p>will write a style sheet with the default properties to file <i>mystyle.css</i>.</p>
4116
4117 <p>The use of style sheets is encouraged, but a web page without a style sheets can be created with the flag <b>-nss</b>. Use this option if you must to be sure that older browsers (roughly speaking, versions prior to 4.0 of Netscape Navigator and Internet Explorer) can display the syntax-coloring of the html files.</p>
4118
4119 </dd>
4120 <dt id="Controlling-HTML-properties"><b>Controlling HTML properties</b></dt>
4121 <dd>
4122
4123 <p>Note: It is usually more convenient to accept the default properties and then edit the stylesheet which is produced. However, this section shows how to control the properties with flags to perltidy.</p>
4124
4125 <p>Syntax colors may be changed from their default values by flags of the either the long form, <b>-html-color-xxxxxx=n</b>, or more conveniently the short form, <b>-hcx=n</b>, where <b>xxxxxx</b> is one of the following words, and <b>x</b> is the corresponding abbreviation:</p>
4126
4127 <pre><code>      Token Type             xxxxxx           x
4128       ----------             --------         --
4129       comment                comment          c
4130       number                 numeric          n
4131       identifier             identifier       i
4132       bareword, function     bareword         w
4133       keyword                keyword          k
4134       quite, pattern         quote            q
4135       here doc text          here-doc-text    h
4136       here doc target        here-doc-target  hh
4137       punctuation            punctuation      pu
4138       parentheses            paren            p
4139       structural braces      structure        s
4140       semicolon              semicolon        sc
4141       colon                  colon            co
4142       comma                  comma            cm
4143       label                  label            j
4144       sub definition name    subroutine       m
4145       pod text               pod-text         pd</code></pre>
4146
4147 <p>A default set of colors has been defined, but they may be changed by providing values to any of the following parameters, where <b>n</b> is either a 6 digit hex RGB color value or an ascii name for a color, such as &#39;red&#39;.</p>
4148
4149 <p>To illustrate, the following command will produce an html file <i>somefile.pl.html</i> with &quot;aqua&quot; keywords:</p>
4150
4151 <pre><code>        perltidy -html -hck=00ffff somefile.pl</code></pre>
4152
4153 <p>and this should be equivalent for most browsers:</p>
4154
4155 <pre><code>        perltidy -html -hck=aqua somefile.pl</code></pre>
4156
4157 <p>Perltidy merely writes any non-hex names that it sees in the html file. The following 16 color names are defined in the HTML 3.2 standard:</p>
4158
4159 <pre><code>        black   =&gt; 000000,
4160         silver  =&gt; c0c0c0,
4161         gray    =&gt; 808080,
4162         white   =&gt; ffffff,
4163         maroon  =&gt; 800000,
4164         red     =&gt; ff0000,
4165         purple  =&gt; 800080,
4166         fuchsia =&gt; ff00ff,
4167         green   =&gt; 008000,
4168         lime    =&gt; 00ff00,
4169         olive   =&gt; 808000,
4170         yellow  =&gt; ffff00
4171         navy    =&gt; 000080,
4172         blue    =&gt; 0000ff,
4173         teal    =&gt; 008080,
4174         aqua    =&gt; 00ffff,</code></pre>
4175
4176 <p>Many more names are supported in specific browsers, but it is safest to use the hex codes for other colors. Helpful color tables can be located with an internet search for &quot;HTML color tables&quot;.</p>
4177
4178 <p>Besides color, two other character attributes may be set: bold, and italics. To set a token type to use bold, use the flag <b>--html-bold-xxxxxx</b> or <b>-hbx</b>, where <b>xxxxxx</b> or <b>x</b> are the long or short names from the above table. Conversely, to set a token type to NOT use bold, use <b>--nohtml-bold-xxxxxx</b> or <b>-nhbx</b>.</p>
4179
4180 <p>Likewise, to set a token type to use an italic font, use the flag <b>--html-italic-xxxxxx</b> or <b>-hix</b>, where again <b>xxxxxx</b> or <b>x</b> are the long or short names from the above table. And to set a token type to NOT use italics, use <b>--nohtml-italic-xxxxxx</b> or <b>-nhix</b>.</p>
4181
4182 <p>For example, to use bold braces and lime color, non-bold, italics keywords the following command would be used:</p>
4183
4184 <pre><code>        perltidy -html -hbs -hck=00FF00 -nhbk -hik somefile.pl</code></pre>
4185
4186 <p>The background color can be specified with <b>--html-color-background=n</b>, or <b>-hcbg=n</b> for short, where n is a 6 character hex RGB value. The default color of text is the value given to <b>punctuation</b>, which is black as a default.</p>
4187
4188 <p>Here are some notes and hints:</p>
4189
4190 <p>1. If you find a preferred set of these parameters, you may want to create a <i>.perltidyrc</i> file containing them. See the perltidy man page for an explanation.</p>
4191
4192 <p>2. Rather than specifying values for these parameters, it is probably easier to accept the defaults and then edit a style sheet. The style sheet contains comments which should make this easy.</p>
4193
4194 <p>3. The syntax-colored html files can be very large, so it may be best to split large files into smaller pieces to improve download times.</p>
4195
4196 </dd>
4197 </dl>
4198
4199 <h1 id="SOME-COMMON-INPUT-CONVENTIONS">SOME COMMON INPUT CONVENTIONS</h1>
4200
4201 <h2 id="Specifying-Block-Types">Specifying Block Types</h2>
4202
4203 <p>Several parameters which refer to code block types may be customized by also specifying an associated list of block types. The type of a block is the name of the keyword which introduces that block, such as <b>if</b>, <b>else</b>, or <b>sub</b>. An exception is a labeled block, which has no keyword, and should be specified with just a colon. To specify all blocks use <b>&#39;*&#39;</b>.</p>
4204
4205 <p>The keyword <b>sub</b> indicates a named sub. For anonymous subs, use the special keyword <b>asub</b>.</p>
4206
4207 <p>For example, the following parameter specifies <code>sub</code>, labels, <code>BEGIN</code>, and <code>END</code> blocks:</p>
4208
4209 <pre><code>   -cscl=&quot;sub : BEGIN END&quot;</code></pre>
4210
4211 <p>(the meaning of the -cscl parameter is described above.) Note that quotes are required around the list of block types because of the spaces. For another example, the following list specifies all block types for vertical tightness:</p>
4212
4213 <pre><code>   -bbvtl=&#39;*&#39;</code></pre>
4214
4215 <h2 id="Specifying-File-Extensions">Specifying File Extensions</h2>
4216
4217 <p>Several parameters allow default file extensions to be overridden. For example, a backup file extension may be specified with <b>-bext=ext</b>, where <b>ext</b> is some new extension. In order to provides the user some flexibility, the following convention is used in all cases to decide if a leading &#39;.&#39; should be used. If the extension <code>ext</code> begins with <code>A-Z</code>, <code>a-z</code>, or <code>0-9</code>, then it will be appended to the filename with an intermediate &#39;.&#39; (or perhaps a &#39;_&#39; on VMS systems). Otherwise, it will be appended directly.</p>
4218
4219 <p>For example, suppose the file is <i>somefile.pl</i>. For <code>-bext=old</code>, a &#39;.&#39; is added to give <i>somefile.pl.old</i>. For <code>-bext=.old</code>, no additional &#39;.&#39; is added, so again the backup file is <i>somefile.pl.old</i>. For <code>-bext=~</code>, then no dot is added, and the backup file will be <i>somefile.pl~</i> .</p>
4220
4221 <h1 id="SWITCHES-WHICH-MAY-BE-NEGATED">SWITCHES WHICH MAY BE NEGATED</h1>
4222
4223 <p>The following list shows all short parameter names which allow a prefix &#39;n&#39; to produce the negated form:</p>
4224
4225 <pre><code> D      anl    asbl   asc    ast    asu    atc    atnl   aws    b
4226  baa    baao   bar    bbao   bbb    bbc    bbs    bl     bli    boa
4227  boc    bok    bol    bom    bos    bot    cblx   ce     conv   cpb
4228  cs     csc    cscb   cscw   dac    dbc    dbs    dcbl   dcsc   ddf
4229  dln    dnl    dop    dp     dpro   drc    dsc    dsm    dsn    dtc
4230  dtt    dwic   dwls   dwrs   dws    eos    f      fll    fpva   frm
4231  fs     fso    gcs    hbc    hbcm   hbco   hbh    hbhh   hbi    hbj
4232  hbk    hbm    hbn    hbp    hbpd   hbpu   hbq    hbs    hbsc   hbv
4233  hbw    hent   hic    hicm   hico   hih    hihh   hii    hij    hik
4234  him    hin    hip    hipd   hipu   hiq    his    hisc   hiv    hiw
4235  hsc    html   ibc    icb    icp    iob    isbc   iscl   kgb    kgbd
4236  kgbi   kis    lal    log    lop    lp     lsl    mem    nib    ohbr
4237  okw    ola    olc    oll    olq    opr    opt    osbc   osbr   otr
4238  ple    pod    pvl    q      sac    sbc    sbl    scbb   schb   scp
4239  scsb   sct    se     sfp    sfs    skp    sob    sobb   sohb   sop
4240  sosb   sot    ssc    st     sts    t      tac    tbc    toc    tp
4241  tqw    trp    ts     tsc    tso    vbc    vc     vmll   vsc    w
4242  wfc    wn     x      xci    xlp    xs</code></pre>
4243
4244 <p>Equivalently, the prefix &#39;no&#39; or &#39;no-&#39; on the corresponding long names may be used.</p>
4245
4246 <h1 id="LIMITATIONS">LIMITATIONS</h1>
4247
4248 <dl>
4249
4250 <dt id="Parsing-Limitations"><b>Parsing Limitations</b></dt>
4251 <dd>
4252
4253 <p>Perltidy should work properly on most perl scripts. It does a lot of self-checking, but still, it is possible that an error could be introduced and go undetected. Therefore, it is essential to make careful backups and to test reformatted scripts.</p>
4254
4255 <p>The main current limitation is that perltidy does not scan modules included with &#39;use&#39; statements. This makes it necessary to guess the context of any bare words introduced by such modules. Perltidy has good guessing algorithms, but they are not infallible. When it must guess, it leaves a message in the log file.</p>
4256
4257 <p>If you encounter a bug, please report it.</p>
4258
4259 </dd>
4260 <dt id="What-perltidy-does-not-parse-and-format"><b>What perltidy does not parse and format</b></dt>
4261 <dd>
4262
4263 <p>Perltidy indents but does not reformat comments and <code>qw</code> quotes. Perltidy does not in any way modify the contents of here documents or quoted text, even if they contain source code. (You could, however, reformat them separately). Perltidy does not format &#39;format&#39; sections in any way. And, of course, it does not modify pod documents.</p>
4264
4265 </dd>
4266 </dl>
4267
4268 <h1 id="FILES">FILES</h1>
4269
4270 <dl>
4271
4272 <dt id="Temporary-files"><b>Temporary files</b></dt>
4273 <dd>
4274
4275 <p>Under the -html option with the default --pod2html flag, a temporary file is required to pass text to Pod::Html. Unix systems will try to use the POSIX tmpnam() function. Otherwise the file <i>perltidy.TMP</i> will be temporarily created in the current working directory.</p>
4276
4277 </dd>
4278 <dt id="Special-files-when-standard-input-is-used"><b>Special files when standard input is used</b></dt>
4279 <dd>
4280
4281 <p>When standard input is used, the log file, if saved, is <i>perltidy.LOG</i>, and any errors are written to <i>perltidy.ERR</i> unless the <b>-se</b> flag is set. These are saved in the current working directory.</p>
4282
4283 </dd>
4284 <dt id="Files-overwritten"><b>Files overwritten</b></dt>
4285 <dd>
4286
4287 <p>The following file extensions are used by perltidy, and files with these extensions may be overwritten or deleted: <i>.ERR</i>, <i>.LOG</i>, <i>.TEE</i>, and/or <i>.tdy</i>, <i>.html</i>, and <i>.bak</i>, depending on the run type and settings.</p>
4288
4289 </dd>
4290 <dt id="Files-extensions-limitations"><b>Files extensions limitations</b></dt>
4291 <dd>
4292
4293 <p>Perltidy does not operate on files for which the run could produce a file with a duplicated file extension. These extensions include <i>.LOG</i>, <i>.ERR</i>, <i>.TEE</i>, and perhaps <i>.tdy</i> and <i>.bak</i>, depending on the run type. The purpose of this rule is to prevent generating confusing filenames such as <i>somefile.tdy.tdy.tdy</i>.</p>
4294
4295 </dd>
4296 </dl>
4297
4298 <h1 id="ERROR-HANDLING">ERROR HANDLING</h1>
4299
4300 <p>An exit value of 0, 1, or 2 is returned by perltidy to indicate the status of the result.</p>
4301
4302 <p>A exit value of 0 indicates that perltidy ran to completion with no error messages.</p>
4303
4304 <p>A non-zero exit value indicates some kind of problem was detected.</p>
4305
4306 <p>An exit value of 1 indicates that perltidy terminated prematurely, usually due to some kind of errors in the input parameters. This can happen for example if a parameter is misspelled or given an invalid value. Error messages in the standard error output will indicate the cause of any problem. If perltidy terminates prematurely then no output files will be produced.</p>
4307
4308 <p>An exit value of 2 indicates that perltidy was able to run to completion but there there are (1) warning messages in the standard error output related to parameter errors or problems and/or (2) warning messages in the perltidy error file(s) relating to possible syntax errors in one or more of the source script(s) being tidied. When multiple files are being processed, an error detected in any single file will produce this type of exit condition.</p>
4309
4310 <h1 id="SEE-ALSO">SEE ALSO</h1>
4311
4312 <p>perlstyle(1), Perl::Tidy(3)</p>
4313
4314 <h1 id="INSTALLATION">INSTALLATION</h1>
4315
4316 <p>The perltidy binary uses the Perl::Tidy module and is installed when that module is installed. The module name is case-sensitive. For example, the basic command for installing with cpanm is &#39;cpanm Perl::Tidy&#39;.</p>
4317
4318 <h1 id="VERSION">VERSION</h1>
4319
4320 <p>This man page documents perltidy version 20230309</p>
4321
4322 <h1 id="BUG-REPORTS">BUG REPORTS</h1>
4323
4324 <p>The source code repository is at <a href="https://github.com/perltidy/perltidy">https://github.com/perltidy/perltidy</a>.</p>
4325
4326 <p>To report a new bug or problem, use the &quot;issues&quot; link on this page.</p>
4327
4328 <h1 id="COPYRIGHT">COPYRIGHT</h1>
4329
4330 <p>Copyright (c) 2000-2022 by Steve Hancock</p>
4331
4332 <h1 id="LICENSE">LICENSE</h1>
4333
4334 <p>This package is free software; you can redistribute it and/or modify it under the terms of the &quot;GNU General Public License&quot;.</p>
4335
4336 <p>Please refer to the file &quot;COPYING&quot; for details.</p>
4337
4338 <h1 id="DISCLAIMER">DISCLAIMER</h1>
4339
4340 <p>This package is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.</p>
4341
4342 <p>See the &quot;GNU General Public License&quot; for more details.</p>
4343
4344
4345 </body>
4346
4347 </html>
4348
4349