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-List-Formatting">Controlling List Formatting</a></li>
  33       <li><a href="#Retaining-or-Ignoring-Existing-Line-Breaks">Retaining or Ignoring Existing Line Breaks</a></li>
  34       <li><a href="#Blank-Line-Control">Blank Line Control</a></li>
  35       <li><a href="#Styles">Styles</a></li>
  36       <li><a href="#Controlling-Vertical-Alignment">Controlling Vertical Alignment</a></li>
  37       <li><a href="#Other-Controls">Other Controls</a></li>
  38     </ul>
  39   </li>
  40   <li><a href="#HTML-OPTIONS">HTML OPTIONS</a></li>
  41   <li><a href="#SOME-COMMON-INPUT-CONVENTIONS">SOME COMMON INPUT CONVENTIONS</a>
  42     <ul>
  43       <li><a href="#Specifying-Block-Types">Specifying Block Types</a></li>
  44       <li><a href="#Specifying-File-Extensions">Specifying File Extensions</a></li>
  45     </ul>
  46   </li>
  47   <li><a href="#SWITCHES-WHICH-MAY-BE-NEGATED">SWITCHES WHICH MAY BE NEGATED</a></li>
  48   <li><a href="#LIMITATIONS">LIMITATIONS</a></li>
  49   <li><a href="#FILES">FILES</a></li>
  50   <li><a href="#ERROR-HANDLING">ERROR HANDLING</a></li>
  51   <li><a href="#SEE-ALSO">SEE ALSO</a></li>
  52   <li><a href="#INSTALLATION">INSTALLATION</a></li>
  53   <li><a href="#VERSION">VERSION</a></li>
  54   <li><a href="#BUG-REPORTS">BUG REPORTS</a></li>
  55   <li><a href="#COPYRIGHT">COPYRIGHT</a></li>
  56   <li><a href="#LICENSE">LICENSE</a></li>
  57   <li><a href="#DISCLAIMER">DISCLAIMER</a></li>
  58 </ul>
  59
  60 <h1 id="NAME">NAME</h1>
  61
  62 <p>perltidy - a perl script indenter and reformatter</p>
  63
  64 <h1 id="SYNOPSIS">SYNOPSIS</h1>
  65
  66 <pre><code>    perltidy [ options ] file1 file2 file3 ...
  67             (output goes to file1.tdy, file2.tdy, file3.tdy, ...)
  68     perltidy [ options ] file1 -o outfile
  69     perltidy [ options ] file1 -st &gt;outfile
  70     perltidy [ options ] &lt;infile &gt;outfile</code></pre>
  71
  72 <h1 id="DESCRIPTION">DESCRIPTION</h1>
  73
  74 <p>Perltidy reads a perl script and writes an indented, reformatted script. This document describes the parameters available for controlling this formatting.</p>
  75
  76 <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>
  77
  78 <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>
  79
  80 <p>A convenient aid to systematically defining a set of style parameters can be found at http://perltidy.sourceforge.net/stylekey.html</p>
  81
  82 <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>
  83
  84 <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>
  85
  86 <h1 id="EXAMPLES">EXAMPLES</h1>
  87
  88 <pre><code>  perltidy somefile.pl</code></pre>
  89
  90 <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>
  91
  92 <pre><code>  perltidy *.pl</code></pre>
  93
  94 <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>
  95
  96 <pre><code>  perltidy -b file1.pl file2.pl</code></pre>
  97
  98 <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>
  99
 100 <pre><code>  perltidy -b -bext=&#39;/&#39; file1.pl file2.pl</code></pre>
 101
 102 <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>
 103
 104 <pre><code>  perltidy -gnu somefile.pl</code></pre>
 105
 106 <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>
 107
 108 <pre><code>  perltidy -i=3 somefile.pl</code></pre>
 109
 110 <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>
 111
 112 <pre><code>  perltidy -i=3 -et=8 somefile.pl</code></pre>
 113
 114 <p>Same as the previous example, except that leading whitespace will be entabbed with one tab character per 8 spaces.</p>
 115
 116 <pre><code>  perltidy -ce -l=72 somefile.pl</code></pre>
 117
 118 <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>
 119
 120 <pre><code>  perltidy -g somefile.pl</code></pre>
 121
 122 <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>
 123
 124 <pre><code>  perltidy -html somefile.pl</code></pre>
 125
 126 <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>
 127
 128 <pre><code>  perltidy -html -css=mystyle.css somefile.pl</code></pre>
 129
 130 <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>
 131
 132 <pre><code>  perltidy -html -pre somefile.pl</code></pre>
 133
 134 <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>
 135
 136 <pre><code>  perltidy -html -ss &gt;mystyle.css</code></pre>
 137
 138 <p>Write a style sheet to <i>mystyle.css</i> and exit.</p>
 139
 140 <pre><code>  perltidy -html -frm mymodule.pm</code></pre>
 141
 142 <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>
 143
 144 <h1 id="OPTIONS---OVERVIEW">OPTIONS - OVERVIEW</h1>
 145
 146 <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>
 147
 148 <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>
 149
 150 <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>
 151
 152 <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>
 153
 154 <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>
 155
 156 <h2 id="I-O-control">I/O control</h2>
 157
 158 <p>The following parameters concern the files which are read and written.</p>
 159
 160 <dl>
 161
 162 <dt id="h---help"><b>-h</b>, <b>--help</b></dt>
 163 <dd>
 164
 165 <p>Show summary of usage and exit.</p>
 166
 167 </dd>
 168 <dt id="o-filename---outfile-filename"><b>-o</b>=filename, <b>--outfile</b>=filename</dt>
 169 <dd>
 170
 171 <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>
 172
 173 </dd>
 174 <dt id="st---standard-output"><b>-st</b>, <b>--standard-output</b></dt>
 175 <dd>
 176
 177 <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>
 178
 179 <pre><code>  perltidy somefile.pl -st &gt;somefile.new.pl</code></pre>
 180
 181 <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>
 182
 183 </dd>
 184 <dt id="se---standard-error-output"><b>-se</b>, <b>--standard-error-output</b></dt>
 185 <dd>
 186
 187 <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>
 188
 189 </dd>
 190 <dt id="oext-ext---output-file-extension-ext"><b>-oext</b>=ext, <b>--output-file-extension</b>=ext</dt>
 191 <dd>
 192
 193 <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>
 194
 195 </dd>
 196 <dt id="opath-path---output-path-path"><b>-opath</b>=path, <b>--output-path</b>=path</dt>
 197 <dd>
 198
 199 <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>
 200
 201 <p>The path should end in a valid path separator character, but perltidy will try to add one if it is missing.</p>
 202
 203 <p>For example</p>
 204
 205 <pre><code> perltidy somefile.pl -opath=/tmp/</code></pre>
 206
 207 <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>
 208
 209 <p>If the path contains spaces, it should be placed in quotes.</p>
 210
 211 <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>
 212
 213 </dd>
 214 <dt id="b---backup-and-modify-in-place"><b>-b</b>, <b>--backup-and-modify-in-place</b></dt>
 215 <dd>
 216
 217 <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>
 218
 219 <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>
 220
 221 <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>
 222
 223 </dd>
 224 <dt id="bext-ext---backup-file-extension-ext"><b>-bext</b>=ext, <b>--backup-file-extension</b>=ext</dt>
 225 <dd>
 226
 227 <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>
 228
 229 <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>
 230
 231 <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>
 232
 233 <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>
 234
 235 <p>Here are some examples:</p>
 236
 237 <pre><code>  Parameter           Extension          Backup File Treatment
 238   &lt;-bext=bak&gt;         F&lt;.bak&gt;            Keep (same as the default behavior)
 239   &lt;-bext=&#39;/&#39;&gt;         F&lt;.bak&gt;            Delete if no errors
 240   &lt;-bext=&#39;/backup&#39;&gt;   F&lt;.backup&gt;         Delete if no errors
 241   &lt;-bext=&#39;original/&#39;&gt; F&lt;.original&gt;       Delete if no errors</code></pre>
 242
 243 </dd>
 244 <dt id="w---warning-output"><b>-w</b>, <b>--warning-output</b></dt>
 245 <dd>
 246
 247 <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>
 248
 249 </dd>
 250 <dt id="q---quiet"><b>-q</b>, <b>--quiet</b></dt>
 251 <dd>
 252
 253 <p>Deactivate error messages (for running under an editor).</p>
 254
 255 <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>
 256
 257 <pre><code> :n1,n2!perltidy -q</code></pre>
 258
 259 <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>
 260
 261 </dd>
 262 <dt id="log---logfile"><b>-log</b>, <b>--logfile</b></dt>
 263 <dd>
 264
 265 <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>
 266
 267 </dd>
 268 <dt id="g-n---logfile-gap-n"><b>-g=n</b>, <b>--logfile-gap=n</b></dt>
 269 <dd>
 270
 271 <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>
 272
 273 <p>Setting <b>-g</b> also causes the logfile to be saved, so it is not necessary to also include <b>-log</b>.</p>
 274
 275 <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>
 276
 277 <p>Setting a negative value of <code>n</code> is the same as not setting <b>-g</b> at all.</p>
 278
 279 </dd>
 280 <dt id="npro---noprofile"><b>-npro</b> <b>--noprofile</b></dt>
 281 <dd>
 282
 283 <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>
 284
 285 <p>If you set the <b>-npro</b> flag, perltidy will not look for this file.</p>
 286
 287 </dd>
 288 <dt id="pro-filename-or---profile-filename"><b>-pro=filename</b> or <b>--profile=filename</b></dt>
 289 <dd>
 290
 291 <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>
 292
 293 <pre><code>   perltidy -pro=testcfg</code></pre>
 294
 295 <p>would cause file <i>testcfg</i> to be used instead of the default <i>.perltidyrc</i>.</p>
 296
 297 <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>
 298
 299 </dd>
 300 <dt id="opt---show-options"><b>-opt</b>, <b>--show-options</b></dt>
 301 <dd>
 302
 303 <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>
 304
 305 </dd>
 306 <dt id="f---force-read-binary"><b>-f</b>, <b>--force-read-binary</b></dt>
 307 <dd>
 308
 309 <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>
 310
 311 </dd>
 312 <dt id="ast---assert-tidy"><b>-ast</b>, <b>--assert-tidy</b></dt>
 313 <dd>
 314
 315 <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>
 316
 317 </dd>
 318 <dt id="asu---assert-untidy"><b>-asu</b>, <b>--assert-untidy</b></dt>
 319 <dd>
 320
 321 <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>
 322
 323 </dd>
 324 <dt id="sal-s---sub-alias-list-s"><b>-sal=s</b>, <b>--sub-alias-list=s</b></dt>
 325 <dd>
 326
 327 <p>This flag causes one or more words to be treated the same as if they were the keyword &#39;sub&#39;. The string <b>s</b> contains one or more alias words, separated by spaces or commas.</p>
 328
 329 <p>For example,</p>
 330
 331 <pre><code>        perltidy -sal=&#39;method fun _sub M4&#39;</code></pre>
 332
 333 <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>
 334
 335 <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>
 336
 337 </dd>
 338 <dt id="gal-s---grep-alias-list-s"><b>-gal=s</b>, <b>--grep-alias-list=s</b></dt>
 339 <dd>
 340
 341 <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>
 342
 343 <p>By &#39;list operator&#39; is meant a function which is invoked in the form</p>
 344
 345 <pre><code>      word {BLOCK} @list</code></pre>
 346
 347 <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>
 348
 349 <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>
 350
 351 <pre><code>        perltidy -gal=&#39;My_grep My_map&#39;</code></pre>
 352
 353 <p>By default, the following list operators in List::Util are automatically included:</p>
 354
 355 <pre><code>      all any first none notall reduce reductions</code></pre>
 356
 357 <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>
 358
 359 </dd>
 360 <dt id="gaxl-s---grep-alias-exclusion-list-s"><b>-gaxl=s</b>, <b>--grep-alias-exclusion-list=s</b></dt>
 361 <dd>
 362
 363 <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>
 364
 365 </dd>
 366 </dl>
 367
 368 <h1 id="FORMATTING-OPTIONS">FORMATTING OPTIONS</h1>
 369
 370 <h2 id="Basic-Options">Basic Options</h2>
 371
 372 <dl>
 373
 374 <dt id="notidy"><b>--notidy</b></dt>
 375 <dd>
 376
 377 <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>
 378
 379 </dd>
 380 <dt id="i-n---indent-columns-n"><b>-i=n</b>, <b>--indent-columns=n</b></dt>
 381 <dd>
 382
 383 <p>Use n columns per indentation level (default n=4).</p>
 384
 385 </dd>
 386 <dt id="l-n---maximum-line-length-n"><b>-l=n</b>, <b>--maximum-line-length=n</b></dt>
 387 <dd>
 388
 389 <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>
 390
 391 <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>
 392
 393 <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>
 394
 395 </dd>
 396 <dt id="vmll---variable-maximum-line-length"><b>-vmll</b>, <b>--variable-maximum-line-length</b></dt>
 397 <dd>
 398
 399 <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>
 400
 401 <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>
 402
 403 <pre><code>      M is the value of --maximum-line-length=M (-l=M), default 80,
 404       I is the value of --indent-columns=I (-i=I), default 4,
 405       L is the indentation level of the line of code</code></pre>
 406
 407 <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>
 408
 409 <p>The default is not to do this (<b>-nvmll</b>).</p>
 410
 411 </dd>
 412 <dt id="wc-n---whitespace-cycle-n"><b>-wc=n</b>, <b>--whitespace-cycle=n</b></dt>
 413 <dd>
 414
 415 <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>
 416
 417 <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>
 418
 419 <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>
 420
 421 <p>The default is not to use this, which can also be indicated using <b>-wc=0</b>.</p>
 422
 423 </dd>
 424 <dt id="Tabs"><b>Tabs</b></dt>
 425 <dd>
 426
 427 <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>
 428
 429 <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>
 430
 431 <dl>
 432
 433 <dt id="et-n---entab-leading-whitespace"><b>-et=n</b>, <b>--entab-leading-whitespace</b></dt>
 434 <dd>
 435
 436 <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>
 437
 438 <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>
 439
 440 </dd>
 441 <dt id="t---tabs"><b>-t</b>, <b>--tabs</b></dt>
 442 <dd>
 443
 444 <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>
 445
 446 </dd>
 447 <dt id="dt-n---default-tabsize-n"><b>-dt=n</b>, <b>--default-tabsize=n</b></dt>
 448 <dd>
 449
 450 <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>
 451
 452 <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>
 453
 454 </dd>
 455 </dl>
 456
 457 </dd>
 458 <dt id="xs---extended-syntax"><b>-xs</b>, <b>--extended-syntax</b></dt>
 459 <dd>
 460
 461 <p>A problem with formatting Perl code is that some modules can introduce new syntax. This flag allows perltidy to handle certain common extensions to the standard syntax without complaint.</p>
 462
 463 <p>For example, without this flag a structure such as the following would generate a syntax error and the braces would not be balanced:</p>
 464
 465 <pre><code>    method deposit( Num $amount) {
 466         $self-&gt;balance( $self-&gt;balance + $amount );
 467     }</code></pre>
 468
 469 <p>For one of the extensions, module Switch::Plain, colons are marked as labels. If you use this module, you may want to also use the <b>--nooutdent-labels</b> flag to prevent lines such as &#39;default:&#39; from being outdented.</p>
 470
 471 <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>
 472
 473 <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>
 474
 475 </dd>
 476 <dt id="io---indent-only"><b>-io</b>, <b>--indent-only</b></dt>
 477 <dd>
 478
 479 <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>
 480
 481 <p>Setting this flag is equivalent to setting <b>--freeze-newlines</b> and <b>--freeze-whitespace</b>.</p>
 482
 483 <p>If you also want to keep your existing blank lines exactly as they are, you can add <b>--freeze-blank-lines</b>.</p>
 484
 485 <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>
 486
 487 <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>
 488
 489 </dd>
 490 <dt id="enc-s---character-encoding-s"><b>-enc=s</b>, <b>--character-encoding=s</b></dt>
 491 <dd>
 492
 493 <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>
 494
 495 <p>The possible values for <b>s</b> are:</p>
 496
 497 <pre><code> -enc=none if no encoding is used, or
 498  -enc=utf8 for encoding in utf8
 499  -enc=guess if perltidy should guess between these two possibilities.</code></pre>
 500
 501 <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>
 502
 503 <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>
 504
 505 <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>
 506
 507 <p>The current default is <b>guess</b>.</p>
 508
 509 <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>
 510
 511 <pre><code>   perltidy -utf8 file.pl</code></pre>
 512
 513 <p>or</p>
 514
 515 <pre><code>   perltidy -guess file.pl</code></pre>
 516
 517 <p>or simply</p>
 518
 519 <pre><code>   perltidy file.pl</code></pre>
 520
 521 <p>since <b>-guess</b> is the default.</p>
 522
 523 <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>
 524
 525 </dd>
 526 <dt id="eos-s---encode-output-strings-s"><b>-eos=s</b>, <b>--encode-output-strings=s</b></dt>
 527 <dd>
 528
 529 <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>
 530
 531 <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>
 532
 533 <ul>
 534
 535 <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>
 536
 537 </li>
 538 <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>
 539
 540 </li>
 541 </ul>
 542
 543 <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>
 544
 545 </dd>
 546 <dt id="gcs---use-unicode-gcstring"><b>-gcs</b>, <b>--use-unicode-gcstring</b></dt>
 547 <dd>
 548
 549 <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>
 550
 551 <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>
 552
 553 <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>
 554
 555 <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>
 556
 557 </dd>
 558 <dt id="ole-s---output-line-ending-s"><b>-ole=s</b>, <b>--output-line-ending=s</b></dt>
 559 <dd>
 560
 561 <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>
 562
 563 </dd>
 564 <dt id="ple---preserve-line-endings"><b>-ple</b>, <b>--preserve-line-endings</b></dt>
 565 <dd>
 566
 567 <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>
 568
 569 </dd>
 570 <dt id="atnl---add-terminal-newline"><b>-atnl</b>, <b>--add-terminal-newline</b></dt>
 571 <dd>
 572
 573 <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>
 574
 575 <p>Negating this flag may be useful for manipulating one-line scripts intended for use on a command line.</p>
 576
 577 </dd>
 578 <dt id="it-n---iterations-n"><b>-it=n</b>, <b>--iterations=n</b></dt>
 579 <dd>
 580
 581 <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>
 582
 583 <p>This flag has no effect when perltidy is used to generate html.</p>
 584
 585 </dd>
 586 <dt id="conv---converge"><b>-conv</b>, <b>--converge</b></dt>
 587 <dd>
 588
 589 <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>
 590
 591 </dd>
 592 </dl>
 593
 594 <h2 id="Code-Indentation-Control">Code Indentation Control</h2>
 595
 596 <dl>
 597
 598 <dt id="ci-n---continuation-indentation-n"><b>-ci=n</b>, <b>--continuation-indentation=n</b></dt>
 599 <dd>
 600
 601 <p>Continuation indentation is extra indentation spaces applied when a long line is broken. The default is n=2, illustrated here:</p>
 602
 603 <pre><code> my $level =   # -ci=2
 604    ( $max_index_to_go &gt;= 0 ) ? $levels_to_go[0] : $last_output_level;</code></pre>
 605
 606 <p>The same example, with n=0, is a little harder to read:</p>
 607
 608 <pre><code> my $level =   # -ci=0
 609  ( $max_index_to_go &gt;= 0 ) ? $levels_to_go[0] : $last_output_level;</code></pre>
 610
 611 <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>
 612
 613 <p>When default values are not used, it is recommended that either</p>
 614
 615 <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>
 616
 617 <p>(2) the flag <b>-extended-continuation-indentation</b> is used (see next section).</p>
 618
 619 </dd>
 620 <dt id="xci---extended-continuation-indentation"><b>-xci</b>, <b>--extended-continuation-indentation</b></dt>
 621 <dd>
 622
 623 <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>
 624
 625 <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>
 626
 627 <pre><code>            # perltidy
 628             foreach $color (
 629                 qw(
 630                 AntiqueWhite3 Bisque1 Bisque2 Bisque3 Bisque4
 631                 SlateBlue3 RoyalBlue1 SteelBlue2 DeepSkyBlue3
 632                 ),
 633                 qw(
 634                 LightBlue1 DarkSlateGray1 Aquamarine2 DarkSeaGreen2
 635                 SeaGreen1 Yellow1 IndianRed1 IndianRed2 Tan1 Tan4
 636                 )
 637               )
 638
 639             # perltidy -xci
 640             foreach $color (
 641                 qw(
 642                     AntiqueWhite3 Bisque1 Bisque2 Bisque3 Bisque4
 643                     SlateBlue3 RoyalBlue1 SteelBlue2 DeepSkyBlue3
 644                 ),
 645                 qw(
 646                     LightBlue1 DarkSlateGray1 Aquamarine2 DarkSeaGreen2
 647                     SeaGreen1 Yellow1 IndianRed1 IndianRed2 Tan1 Tan4
 648                 )
 649               )</code></pre>
 650
 651 </dd>
 652 <dt id="sil-n---starting-indentation-level-n"><b>-sil=n</b> <b>--starting-indentation-level=n</b></dt>
 653 <dd>
 654
 655 <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>
 656
 657 <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>
 658
 659 <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>
 660
 661 </dd>
 662 <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>
 663 <dd>
 664
 665 <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>
 666
 667 <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>
 668
 669 <pre><code>    # perltidy (default)
 670     @month_of_year = (
 671         &#39;Jan&#39;, &#39;Feb&#39;, &#39;Mar&#39;, &#39;Apr&#39;, &#39;May&#39;, &#39;Jun&#39;,
 672         &#39;Jul&#39;, &#39;Aug&#39;, &#39;Sep&#39;, &#39;Oct&#39;, &#39;Nov&#39;, &#39;Dec&#39;
 673     );</code></pre>
 674
 675 <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>
 676
 677 <pre><code>    # perltidy -lp or -xlp
 678     @month_of_year = (
 679                        &#39;Jan&#39;, &#39;Feb&#39;, &#39;Mar&#39;, &#39;Apr&#39;, &#39;May&#39;, &#39;Jun&#39;,
 680                        &#39;Jul&#39;, &#39;Aug&#39;, &#39;Sep&#39;, &#39;Oct&#39;, &#39;Nov&#39;, &#39;Dec&#39;
 681     );</code></pre>
 682
 683 <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>
 684
 685 <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>
 686
 687 <p>Some limitations on these flags are:</p>
 688
 689 <ul>
 690
 691 <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>
 692
 693 </li>
 694 <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>
 695
 696 </li>
 697 <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>
 698
 699 </li>
 700 </ul>
 701
 702 <p>There are some potential disadvantages of this indentation method compared to the default method that should be noted:</p>
 703
 704 <ul>
 705
 706 <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>
 707
 708 </li>
 709 <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>
 710
 711 </li>
 712 </ul>
 713
 714 <p>Some things that can be done to minimize these problems are:</p>
 715
 716 <ul>
 717
 718 <li><p>Increase <b>--maximum-line-length=n</b> above the default <b>n=80</b> characters if necessary.</p>
 719
 720 </li>
 721 <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>
 722
 723 </li>
 724 <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>
 725
 726 </li>
 727 </ul>
 728
 729 </dd>
 730 <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>
 731 <dd>
 732
 733 <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>
 734
 735 <p>Use <b>-lpil=s</b> to specify the containers to which <b>-lp</b> applies, or</p>
 736
 737 <p>use <b>-lpxl=s</b> to specify the containers to which <b>-lp</b> does NOT apply.</p>
 738
 739 <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>
 740
 741 <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>
 742
 743 <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>
 744
 745 <pre><code>  -lpil=&#39;(&#39;</code></pre>
 746
 747 <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>
 748
 749 <pre><code>  -lpxl = &#39;[ {&#39;</code></pre>
 750
 751 <p>which says to exclude lists within square-brackets and braces. So what remains is lists within parentheses.</p>
 752
 753 <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>
 754
 755 <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;),
 756  &#39;K&#39; matches if &#39;k&#39; does not, meaning that the previous token is not a keyword.
 757  &#39;f&#39; matches if the previous token is a function other than a keyword.
 758  &#39;F&#39; matches if &#39;f&#39; does not.
 759  &#39;w&#39; matches if either &#39;k&#39; or &#39;f&#39; match.
 760  &#39;W&#39; matches if &#39;w&#39; does not.</code></pre>
 761
 762 <p>For example:</p>
 763
 764 <pre><code>  -lpil = &#39;f(&#39;</code></pre>
 765
 766 <p>means only apply -lp to function calls, and</p>
 767
 768 <pre><code>  -lpil = &#39;w(&#39;</code></pre>
 769
 770 <p>means only apply -lp to parenthesized lists which follow a function or a keyword.</p>
 771
 772 <p>This last example could alternatively be written using the <b>-lpxl=s</b> flag as</p>
 773
 774 <pre><code>  -lpxl = &#39;[ { W(&#39;</code></pre>
 775
 776 <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>
 777
 778 <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>
 779
 780 <pre><code>  &#39;0&#39; or blank: no check on contents is made
 781   &#39;1&#39; exclude B&lt;-lp&gt; unless the contents is a simple list without sublists
 782   &#39;2&#39; exclude B&lt;-lp&gt; unless the contents is a simple list without sublists, without
 783       code blocks, and without ternary operators</code></pre>
 784
 785 <p>For example,</p>
 786
 787 <pre><code>  -lpil = &#39;f(2&#39;</code></pre>
 788
 789 <p>means only apply -lp to function call lists which do not contain any sublists, code blocks or ternary expressions.</p>
 790
 791 </dd>
 792 <dt id="cti-n---closing-token-indentation"><b>-cti=n</b>, <b>--closing-token-indentation</b></dt>
 793 <dd>
 794
 795 <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>
 796
 797 <pre><code> -cti = 0 no extra indentation (default)
 798  -cti = 1 extra indentation such that the closing token
 799         aligns with its opening token.
 800  -cti = 2 one extra indentation level if the line looks like:
 801         );  or  ];  or  };
 802  -cti = 3 one extra indentation level always</code></pre>
 803
 804 <p>The flags <b>-cti=1</b> and <b>-cti=2</b> work well with the <b>-lp</b> flag (previous section).</p>
 805
 806 <pre><code>    # perltidy -lp -cti=1
 807     @month_of_year = (
 808                        &#39;Jan&#39;, &#39;Feb&#39;, &#39;Mar&#39;, &#39;Apr&#39;, &#39;May&#39;, &#39;Jun&#39;,
 809                        &#39;Jul&#39;, &#39;Aug&#39;, &#39;Sep&#39;, &#39;Oct&#39;, &#39;Nov&#39;, &#39;Dec&#39;
 810                      );
 811
 812     # perltidy -lp -cti=2
 813     @month_of_year = (
 814                        &#39;Jan&#39;, &#39;Feb&#39;, &#39;Mar&#39;, &#39;Apr&#39;, &#39;May&#39;, &#39;Jun&#39;,
 815                        &#39;Jul&#39;, &#39;Aug&#39;, &#39;Sep&#39;, &#39;Oct&#39;, &#39;Nov&#39;, &#39;Dec&#39;
 816                        );</code></pre>
 817
 818 <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>
 819
 820 <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>
 821
 822 </dd>
 823 <dt id="icp---indent-closing-paren"><b>-icp</b>, <b>--indent-closing-paren</b></dt>
 824 <dd>
 825
 826 <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>
 827
 828 </dd>
 829 <dt id="icb---indent-closing-brace"><b>-icb</b>, <b>--indent-closing-brace</b></dt>
 830 <dd>
 831
 832 <p>The <b>-icb</b> option gives one extra level of indentation to a brace which terminates a code block . For example,</p>
 833
 834 <pre><code>        if ($task) {
 835             yyy();
 836             }    # -icb
 837         else {
 838             zzz();
 839             }</code></pre>
 840
 841 <p>The default is not to do this, indicated by <b>-nicb</b>.</p>
 842
 843 </dd>
 844 <dt id="nib---non-indenting-braces"><b>-nib</b>, <b>--non-indenting-braces</b></dt>
 845 <dd>
 846
 847 <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>
 848
 849 <pre><code>            { #&lt;&lt;&lt;   a closure to contain lexical vars
 850
 851             my $var;  # this line does not get one level of indentation
 852             ...
 853
 854             }
 855
 856             # this line does not &#39;see&#39; $var;</code></pre>
 857
 858 <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>
 859
 860 <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>
 861
 862 <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>
 863
 864 <p>The special side comment can be changed with the next parameter.</p>
 865
 866 </dd>
 867 <dt id="nibp-s---non-indenting-brace-prefix-s"><b>-nibp=s</b>, <b>--non-indenting-brace-prefix=s</b></dt>
 868 <dd>
 869
 870 <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>
 871
 872 <p>For example, to match the side comment &#39;#++&#39;, the parameter would be</p>
 873
 874 <pre><code>  -nibp=&#39;#\+\+&#39;</code></pre>
 875
 876 </dd>
 877 <dt id="olq---outdent-long-quotes"><b>-olq</b>, <b>--outdent-long-quotes</b></dt>
 878 <dd>
 879
 880 <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>
 881
 882 </dd>
 883 <dt id="oll---outdent-long-lines"><b>-oll</b>, <b>--outdent-long-lines</b></dt>
 884 <dd>
 885
 886 <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>
 887
 888 </dd>
 889 <dt id="Outdenting-Labels:--ola---outdent-labels"><b>Outdenting Labels:</b> <b>-ola</b>, <b>--outdent-labels</b></dt>
 890 <dd>
 891
 892 <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>
 893
 894 <pre><code>        my $i;
 895       LOOP: while ( $i = &lt;FOTOS&gt; ) {
 896             chomp($i);
 897             next unless $i;
 898             fixit($i);
 899         }</code></pre>
 900
 901 <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>
 902
 903 </dd>
 904 <dt id="Outdenting-Keywords"><b>Outdenting Keywords</b></dt>
 905 <dd>
 906
 907 <dl>
 908
 909 <dt id="okw---outdent-keywords"><b>-okw</b>, <b>--outdent-keywords</b></dt>
 910 <dd>
 911
 912 <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>
 913
 914 <p>For example, using <code>perltidy -okw</code> on the previous example gives:</p>
 915
 916 <pre><code>        my $i;
 917       LOOP: while ( $i = &lt;FOTOS&gt; ) {
 918             chomp($i);
 919           next unless $i;
 920             fixit($i);
 921         }</code></pre>
 922
 923 <p>The default is not to do this.</p>
 924
 925 </dd>
 926 <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>
 927 <dd>
 928
 929 <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>
 930
 931 <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>
 932
 933 </dd>
 934 </dl>
 935
 936 </dd>
 937 </dl>
 938
 939 <h2 id="Whitespace-Control">Whitespace Control</h2>
 940
 941 <p>Whitespace refers to the blank space between variables, operators, and other code tokens.</p>
 942
 943 <dl>
 944
 945 <dt id="fws---freeze-whitespace"><b>-fws</b>, <b>--freeze-whitespace</b></dt>
 946 <dd>
 947
 948 <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>
 949
 950 </dd>
 951 <dt id="Tightness-of-curly-braces-parentheses-and-square-brackets"><b>Tightness of curly braces, parentheses, and square brackets</b></dt>
 952 <dd>
 953
 954 <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>
 955
 956 <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>
 957
 958 <pre><code> if ( ( my $len_tab = length( $tabstr ) ) &gt; 0 ) {  # -pt=0
 959  if ( ( my $len_tab = length($tabstr) ) &gt; 0 ) {    # -pt=1 (default)
 960  if ((my $len_tab = length($tabstr)) &gt; 0) {        # -pt=2</code></pre>
 961
 962 <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>
 963
 964 <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>
 965
 966 <pre><code> $width = $col[ $j + $k ] - $col[ $j ];  # -sbt=0
 967  $width = $col[ $j + $k ] - $col[$j];    # -sbt=1 (default)
 968  $width = $col[$j + $k] - $col[$j];      # -sbt=2</code></pre>
 969
 970 <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>
 971
 972 <pre><code> $obj-&gt;{ $parsed_sql-&gt;{ &#39;table&#39; }[0] };    # -bt=0
 973  $obj-&gt;{ $parsed_sql-&gt;{&#39;table&#39;}[0] };      # -bt=1 (default)
 974  $obj-&gt;{$parsed_sql-&gt;{&#39;table&#39;}[0]};        # -bt=2</code></pre>
 975
 976 <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>
 977
 978 <pre><code> %bf = map { $_ =&gt; -M $_ } grep { /\.deb$/ } dirents &#39;.&#39;; # -bbt=0 (default)
 979  %bf = map { $_ =&gt; -M $_ } grep {/\.deb$/} dirents &#39;.&#39;;   # -bbt=1
 980  %bf = map {$_ =&gt; -M $_} grep {/\.deb$/} dirents &#39;.&#39;;     # -bbt=2</code></pre>
 981
 982 <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>
 983
 984 </dd>
 985 <dt id="tso---tight-secret-operators"><b>-tso</b>, <b>--tight-secret-operators</b></dt>
 986 <dd>
 987
 988 <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>
 989
 990 <pre><code>     0+  +0  ()x!! ~~&lt;&gt;  ,=&gt;   =( )=</code></pre>
 991
 992 <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>
 993
 994 </dd>
 995 <dt id="sts---space-terminal-semicolon"><b>-sts</b>, <b>--space-terminal-semicolon</b></dt>
 996 <dd>
 997
 998 <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>
 999
1000 <pre><code>        $i = 1 ;     #  -sts
1001         $i = 1;      #  -nsts   (default)</code></pre>
1002
1003 </dd>
1004 <dt id="sfs---space-for-semicolon"><b>-sfs</b>, <b>--space-for-semicolon</b></dt>
1005 <dd>
1006
1007 <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>
1008
1009 <pre><code> for ( @a = @$ap, $u = shift @a ; @a ; $u = $v ) {  # -sfs (default)
1010  for ( @a = @$ap, $u = shift @a; @a; $u = $v ) {    # -nsfs</code></pre>
1011
1012 </dd>
1013 <dt id="asc---add-semicolons"><b>-asc</b>, <b>--add-semicolons</b></dt>
1014 <dd>
1015
1016 <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>
1017
1018 </dd>
1019 <dt id="dsm---delete-semicolons"><b>-dsm</b>, <b>--delete-semicolons</b></dt>
1020 <dd>
1021
1022 <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>
1023
1024 </dd>
1025 <dt id="aws---add-whitespace"><b>-aws</b>, <b>--add-whitespace</b></dt>
1026 <dd>
1027
1028 <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>
1029
1030 </dd>
1031 <dt id="dws---delete-old-whitespace"><b>-dws</b>, <b>--delete-old-whitespace</b></dt>
1032 <dd>
1033
1034 <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>
1035
1036 </dd>
1037 <dt id="Detailed-whitespace-controls-around-tokens"><b>Detailed whitespace controls around tokens</b></dt>
1038 <dd>
1039
1040 <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>
1041
1042 <p><b>-wls=s</b> or <b>--want-left-space=s</b>,</p>
1043
1044 <p><b>-nwls=s</b> or <b>--nowant-left-space=s</b>,</p>
1045
1046 <p><b>-wrs=s</b> or <b>--want-right-space=s</b>,</p>
1047
1048 <p><b>-nwrs=s</b> or <b>--nowant-right-space=s</b>.</p>
1049
1050 <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>
1051
1052 <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>
1053
1054 <pre><code>  -nwls=&quot;= + - / *&quot;    -nwrs=&quot;= + - / *&quot;</code></pre>
1055
1056 <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>
1057
1058 <pre><code>  $root = -$b + sqrt( $b * $b - 4. * $a * $c ) / ( 2. * $a );</code></pre>
1059
1060 <p>becomes this:</p>
1061
1062 <pre><code>  $root=-$b+sqrt( $b*$b-4.*$a*$c )/( 2.*$a );</code></pre>
1063
1064 <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>
1065
1066 <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>
1067
1068 <p><b>WARNING</b> Be sure to put these tokens in quotes to avoid having them misinterpreted by your command shell.</p>
1069
1070 </dd>
1071 <dt id="Note1:-Perltidy-does-always-follow-whitespace-controls"><b>Note1: Perltidy does always follow whitespace controls</b></dt>
1072 <dd>
1073
1074 <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>
1075
1076 <pre><code>   sub print_div {
1077       my ($x,$y)=@_;
1078       print $x/$y;
1079    }</code></pre>
1080
1081 <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>
1082
1083 <pre><code>   sub print_div {
1084        my ($x,$y)=@_;
1085        print $x /$y;
1086    }</code></pre>
1087
1088 <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>
1089
1090 <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>
1091
1092 <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>
1093
1094 <pre><code>   system($foo );
1095    system($foo);</code></pre>
1096
1097 <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>
1098
1099 <pre><code>   1: system($foo );
1100    1: kkkkkk{ZZZZb};</code></pre>
1101
1102 <p>which shows that <b>system</b> is type <b>k</b> (keyword) and $foo is type <b>Z</b>.</p>
1103
1104 </dd>
1105 <dt id="Note2:-Perltidys-whitespace-rules-are-not-perfect"><b>Note2: Perltidy&#39;s whitespace rules are not perfect</b></dt>
1106 <dd>
1107
1108 <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>
1109
1110 <pre><code>  # original programming, syntax ok
1111   my @newkeys = map $_-$nrecs+@data, @oldkeys;
1112
1113   # perltidy default, syntax ok
1114   my @newkeys = map $_ - $nrecs + @data, @oldkeys;</code></pre>
1115
1116 <p>But the following will give a syntax error:</p>
1117
1118 <pre><code>  # perltidy -nwrs=&#39;-&#39;
1119   my @newkeys = map $_ -$nrecs + @data, @oldkeys;</code></pre>
1120
1121 <p>For another example, the following two lines will be parsed without syntax error:</p>
1122
1123 <pre><code>  # original programming, syntax ok
1124   for my $severity ( reverse $SEVERITY_LOWEST+1 .. $SEVERITY_HIGHEST ) { ...  }
1125
1126   # perltidy default, syntax ok
1127   for my $severity ( reverse $SEVERITY_LOWEST + 1 .. $SEVERITY_HIGHEST ) { ... }</code></pre>
1128
1129 <p>But the following will give a syntax error:</p>
1130
1131 <pre><code>  # perltidy -nwrs=&#39;+&#39;, syntax error:
1132   for my $severity ( reverse $SEVERITY_LOWEST +1 .. $SEVERITY_HIGHEST ) { ... }</code></pre>
1133
1134 <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>
1135
1136 </dd>
1137 <dt id="Space-between-specific-keywords-and-opening-paren"><b>Space between specific keywords and opening paren</b></dt>
1138 <dd>
1139
1140 <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>
1141
1142 <pre><code>   my local our and or xor eq ne if else elsif until unless
1143    while for foreach return switch case given when</code></pre>
1144
1145 <p>These defaults can be modified with two commands:</p>
1146
1147 <p><b>-sak=s</b> or <b>--space-after-keyword=s</b> adds keywords.</p>
1148
1149 <p><b>-nsak=s</b> or <b>--nospace-after-keyword=s</b> removes keywords.</p>
1150
1151 <p>where <b>s</b> is a list of keywords (in quotes if necessary). For example,</p>
1152
1153 <pre><code>  my ( $a, $b, $c ) = @_;    # default
1154   my( $a, $b, $c ) = @_;     # -nsak=&quot;my local our&quot;</code></pre>
1155
1156 <p>The abbreviation <b>-nsak=&#39;*&#39;</b> is equivalent to including all of the keywords in the above list.</p>
1157
1158 <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>
1159
1160 <p>To put a space after all keywords, see the next item.</p>
1161
1162 </dd>
1163 <dt id="Space-between-all-keywords-and-opening-parens"><b>Space between all keywords and opening parens</b></dt>
1164 <dd>
1165
1166 <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>
1167
1168 <p><b>-skp</b> or <b>--space-keyword-paren</b></p>
1169
1170 <p>You may also want to use the flag <b>-sfp</b> (next item) too.</p>
1171
1172 </dd>
1173 <dt id="Space-between-all-function-names-and-opening-parens"><b>Space between all function names and opening parens</b></dt>
1174 <dd>
1175
1176 <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>
1177
1178 <p><b>-sfp</b> or <b>--space-function-paren</b></p>
1179
1180 <pre><code>  myfunc( $a, $b, $c );    # default
1181   myfunc ( $a, $b, $c );   # -sfp</code></pre>
1182
1183 <p>You will probably also want to use the flag <b>-skp</b> (previous item) too.</p>
1184
1185 <p>The reason this is not recommended is that 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>
1186
1187 <pre><code>  if ( -e filename() ) { print &quot;I&#39;m here\n&quot;; }
1188   sub filename { return $0 }</code></pre>
1189
1190 <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>
1191
1192 </dd>
1193 <dt id="fpva-or---function-paren-vertical-alignment"><b>-fpva</b> or <b>--function-paren-vertical-alignment</b></dt>
1194 <dd>
1195
1196 <p>A side-effect of using the <b>-sfp</b> flag is that the parens may become vertically aligned. For example,</p>
1197
1198 <pre><code>    # perltidy -sfp
1199     myfun     ( $aaa, $b, $cc );
1200     mylongfun ( $a, $b, $c );</code></pre>
1201
1202 <p>This is the default behavior. To prevent this alignment use <b>-nfpva</b>:</p>
1203
1204 <pre><code>    # perltidy -sfp -nfpva
1205     myfun ( $aaa, $b, $cc );
1206     mylongfun ( $a, $b, $c );</code></pre>
1207
1208 </dd>
1209 <dt id="spp-n-or---space-prototype-paren-n"><b>-spp=n</b> or <b>--space-prototype-paren=n</b></dt>
1210 <dd>
1211
1212 <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>
1213
1214 <pre><code>      sub usage();</code></pre>
1215
1216 <p>This integer <b>n</b> may have the value 0, 1, or 2 as follows:</p>
1217
1218 <pre><code>    -spp=0 means no space before the paren
1219     -spp=1 means follow the example of the source code [DEFAULT]
1220     -spp=2 means always put a space before the paren</code></pre>
1221
1222 <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>
1223
1224 <pre><code>        sub usage();    # n=0 [no space]
1225         sub usage();    # n=1 [default; follows input]
1226         sub usage ();   # n=2 [space]</code></pre>
1227
1228 </dd>
1229 <dt id="kpit-n-or---keyword-paren-inner-tightness-n"><b>-kpit=n</b> or <b>--keyword-paren-inner-tightness=n</b></dt>
1230 <dd>
1231
1232 <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>
1233
1234 <pre><code>   -kpit=0 means always put a space (not tight)
1235    -kpit=1 means ignore this parameter [default]
1236    -kpit=2 means never put a space (tight)</code></pre>
1237
1238 <p>To illustrate, the following snippet is shown formatted in three ways:</p>
1239
1240 <pre><code>    if ( seek( DATA, 0, 0 ) ) { ... }    # perltidy (default)
1241     if (seek(DATA, 0, 0)) { ... }        # perltidy -pt=2
1242     if ( seek(DATA, 0, 0) ) { ... }      # perltidy -pt=2 -kpit=0</code></pre>
1243
1244 <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>
1245
1246 <p>The set of keywords to which this parameter applies are by default are:</p>
1247
1248 <pre><code>   if elsif unless while until for foreach</code></pre>
1249
1250 <p>These can be changed with the parameter <b>-kpitl=s</b> described in the next section.</p>
1251
1252 </dd>
1253 <dt id="kpitl-string-or---keyword-paren-inner-tightness-string"><b>-kpitl=string</b> or <b>--keyword-paren-inner-tightness=string</b></dt>
1254 <dd>
1255
1256 <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>
1257
1258 <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>
1259
1260 </dd>
1261 <dt id="lop-or---logical-padding"><b>-lop</b> or <b>--logical-padding</b></dt>
1262 <dd>
1263
1264 <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>
1265
1266 <pre><code>    # perltidy [default formatting]
1267     $same =
1268       (      ( $aP eq $bP )
1269           &amp;&amp; ( $aS eq $bS )
1270           &amp;&amp; ( $aT eq $bT )
1271           &amp;&amp; ( $a-&gt;{&#39;title&#39;} eq $b-&gt;{&#39;title&#39;} )
1272           &amp;&amp; ( $a-&gt;{&#39;href&#39;} eq $b-&gt;{&#39;href&#39;} ) );</code></pre>
1273
1274 <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>
1275
1276 <p>Here is an example involving a ternary operator:</p>
1277
1278 <pre><code>    # perltidy [default formatting]
1279     $bits =
1280         $top &gt; 0xffff ? 32
1281       : $top &gt; 0xff   ? 16
1282       : $top &gt; 1      ? 8
1283       :                 1;</code></pre>
1284
1285 <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>
1286
1287 <pre><code>    # perltidy -nlop
1288     $same =
1289       ( ( $aP eq $bP )
1290           &amp;&amp; ( $aS eq $bS )
1291           &amp;&amp; ( $aT eq $bT )
1292           &amp;&amp; ( $a-&gt;{&#39;title&#39;} eq $b-&gt;{&#39;title&#39;} )
1293           &amp;&amp; ( $a-&gt;{&#39;href&#39;} eq $b-&gt;{&#39;href&#39;} ) );
1294
1295     # perltidy -nlop
1296     $bits =
1297       $top &gt; 0xffff ? 32
1298       : $top &gt; 0xff ? 16
1299       : $top &gt; 1    ? 8
1300       :               1;</code></pre>
1301
1302 </dd>
1303 <dt id="Trimming-whitespace-around-qw-quotes"><b>Trimming whitespace around <code>qw</code> quotes</b></dt>
1304 <dd>
1305
1306 <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>
1307
1308 <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>
1309
1310 </dd>
1311 <dt id="sbq-n-or---space-backslash-quote-n"><b>-sbq=n</b> or <b>--space-backslash-quote=n</b></dt>
1312 <dd>
1313
1314 <p>lines like</p>
1315
1316 <pre><code>       $str1=\&quot;string1&quot;;
1317        $str2=\&#39;string2&#39;;</code></pre>
1318
1319 <p>can confuse syntax highlighters unless a space is included between the backslash and the single or double quotation mark.</p>
1320
1321 <p>this can be controlled with the value of <b>n</b> as follows:</p>
1322
1323 <pre><code>    -sbq=0 means no space between the backslash and quote
1324     -sbq=1 means follow the example of the source code
1325     -sbq=2 means always put a space between the backslash and quote</code></pre>
1326
1327 <p>The default is <b>-sbq=1</b>, meaning that a space will be used if there is one in the source code.</p>
1328
1329 </dd>
1330 <dt id="Trimming-trailing-whitespace-from-lines-of-POD"><b>Trimming trailing whitespace from lines of POD</b></dt>
1331 <dd>
1332
1333 <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>
1334
1335 </dd>
1336 </dl>
1337
1338 <h2 id="Comment-Controls">Comment Controls</h2>
1339
1340 <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>
1341
1342 <dl>
1343
1344 <dt id="ibc---indent-block-comments"><b>-ibc</b>, <b>--indent-block-comments</b></dt>
1345 <dd>
1346
1347 <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>
1348
1349 <pre><code>             # this comment is indented      (-ibc, default)
1350              if ($task) { yyy(); }</code></pre>
1351
1352 <p>The alternative is <b>-nibc</b>:</p>
1353
1354 <pre><code> # this comment is not indented              (-nibc)
1355              if ($task) { yyy(); }</code></pre>
1356
1357 <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>
1358
1359 </dd>
1360 <dt id="isbc---indent-spaced-block-comments"><b>-isbc</b>, <b>--indent-spaced-block-comments</b></dt>
1361 <dd>
1362
1363 <p>If there is no leading space on the line, then the comment will not be indented, and otherwise it may be.</p>
1364
1365 <p>If both <b>-ibc</b> and <b>-isbc</b> are set, then <b>-isbc</b> takes priority.</p>
1366
1367 </dd>
1368 <dt id="olc---outdent-long-comments"><b>-olc</b>, <b>--outdent-long-comments</b></dt>
1369 <dd>
1370
1371 <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>
1372
1373 </dd>
1374 <dt id="msc-n---minimum-space-to-comment-n"><b>-msc=n</b>, <b>--minimum-space-to-comment=n</b></dt>
1375 <dd>
1376
1377 <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>
1378
1379 </dd>
1380 <dt id="fpsc-n---fixed-position-side-comment-n"><b>-fpsc=n</b>, <b>--fixed-position-side-comment=n</b></dt>
1381 <dd>
1382
1383 <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>
1384
1385 </dd>
1386 <dt id="iscl---ignore-side-comment-lengths"><b>-iscl</b>, <b>--ignore-side-comment-lengths</b></dt>
1387 <dd>
1388
1389 <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>
1390
1391 <pre><code>     perltidy -l=80 -iscl
1392         $vmsfile =~ s/;[\d\-]*$//; # Clip off version number; we can use a newer version as well</code></pre>
1393
1394 <p>whereas without the -iscl flag the line will be broken:</p>
1395
1396 <pre><code>     perltidy -l=80
1397         $vmsfile =~ s/;[\d\-]*$//
1398           ;    # Clip off version number; we can use a newer version as well</code></pre>
1399
1400 </dd>
1401 <dt id="hsc---hanging-side-comments"><b>-hsc</b>, <b>--hanging-side-comments</b></dt>
1402 <dd>
1403
1404 <p>By default, perltidy tries to identify and align &quot;hanging side comments&quot;, which are something like this:</p>
1405
1406 <pre><code>        my $IGNORE = 0;    # This is a side comment
1407                            # This is a hanging side comment
1408                            # And so is this</code></pre>
1409
1410 <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>
1411
1412 </dd>
1413 <dt id="Closing-Side-Comments"><b>Closing Side Comments</b></dt>
1414 <dd>
1415
1416 <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>
1417
1418 <pre><code>        sub message {
1419             if ( !defined( $_[0] ) ) {
1420                 print(&quot;Hello, World\n&quot;);
1421             }
1422             else {
1423                 print( $_[0], &quot;\n&quot; );
1424             }
1425         }</code></pre>
1426
1427 <p>And here is the result of processing with <code>perltidy -csc</code>:</p>
1428
1429 <pre><code>        sub message {
1430             if ( !defined( $_[0] ) ) {
1431                 print(&quot;Hello, World\n&quot;);
1432             }
1433             else {
1434                 print( $_[0], &quot;\n&quot; );
1435             }
1436         } ## end sub message</code></pre>
1437
1438 <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>
1439
1440 <p>The command <b>-dcsc</b> (or <b>--delete-closing-side-comments</b>) reverses this process and removes these comments.</p>
1441
1442 <p>Several commands are available to modify the behavior of these two basic commands, <b>-csc</b> and <b>-dcsc</b>:</p>
1443
1444 <dl>
1445
1446 <dt id="csci-n-or---closing-side-comment-interval-n"><b>-csci=n</b>, or <b>--closing-side-comment-interval=n</b></dt>
1447 <dd>
1448
1449 <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>
1450
1451 <pre><code>        # perltidy -csci=2 -csc
1452         sub message {
1453             if ( !defined( $_[0] ) ) {
1454                 print(&quot;Hello, World\n&quot;);
1455             } ## end if ( !defined( $_[0] ))
1456             else {
1457                 print( $_[0], &quot;\n&quot; );
1458             } ## end else [ if ( !defined( $_[0] ))
1459         } ## end sub message</code></pre>
1460
1461 <p>Now the <code>if</code> and <code>else</code> blocks are commented. However, now this has become very cluttered.</p>
1462
1463 </dd>
1464 <dt id="cscp-string-or---closing-side-comment-prefix-string"><b>-cscp=string</b>, or <b>--closing-side-comment-prefix=string</b></dt>
1465 <dd>
1466
1467 <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>
1468
1469 </dd>
1470 <dt id="cscl-string-or---closing-side-comment-list"><b>-cscl=string</b>, or <b>--closing-side-comment-list</b></dt>
1471 <dd>
1472
1473 <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>
1474
1475 <pre><code>   -cscl=&quot;sub : BEGIN END&quot;</code></pre>
1476
1477 </dd>
1478 <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>
1479 <dd>
1480
1481 <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>
1482
1483 </dd>
1484 <dt id="cscb-or---closing-side-comments-balanced"><b>-cscb</b>, or <b>--closing-side-comments-balanced</b></dt>
1485 <dd>
1486
1487 <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>
1488
1489 <pre><code>  perltidy -csc -ncscb
1490   } ## end foreach my $foo (sort { $b cmp $a ...</code></pre>
1491
1492 <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>
1493
1494 <pre><code>  perltidy -csc -cscb
1495   } ## end foreach my $foo (sort { $b cmp $a ... })</code></pre>
1496
1497 <p>The default is <b>-cscb</b>.</p>
1498
1499 </dd>
1500 <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>
1501 <dd>
1502
1503 <p>The default, <b>n=0</b>, places the text of the opening <code>if</code> statement after any terminal <code>else</code>.</p>
1504
1505 <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>
1506
1507 <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>
1508
1509 </dd>
1510 <dt id="cscb-or---closing-side-comments-balanced1"><b>-cscb</b>, or <b>--closing-side-comments-balanced</b></dt>
1511 <dd>
1512
1513 <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>
1514
1515 <pre><code>  perltidy -csc -ncscb
1516   } ## end foreach my $foo (sort { $b cmp $a ...</code></pre>
1517
1518 <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>
1519
1520 <pre><code>  perltidy -csc -cscb
1521   } ## end foreach my $foo (sort { $b cmp $a ... })</code></pre>
1522
1523 <p>The default is <b>-cscb</b>.</p>
1524
1525 </dd>
1526 <dt id="cscw-or---closing-side-comment-warnings"><b>-cscw</b>, or <b>--closing-side-comment-warnings</b></dt>
1527 <dd>
1528
1529 <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>
1530
1531 <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>
1532
1533 </dd>
1534 </dl>
1535
1536 <p><b>Important Notes on Closing Side Comments:</b></p>
1537
1538 <ul>
1539
1540 <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>
1541
1542 </li>
1543 <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>
1544
1545 </li>
1546 <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>
1547
1548 </li>
1549 <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>
1550
1551 </li>
1552 <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>
1553
1554 </li>
1555 <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>
1556
1557 </li>
1558 </ul>
1559
1560 </dd>
1561 <dt id="Static-Block-Comments"><b>Static Block Comments</b></dt>
1562 <dd>
1563
1564 <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>
1565
1566 <dl>
1567
1568 <dt id="sbc---static-block-comments"><b>-sbc</b>, <b>--static-block-comments</b></dt>
1569 <dd>
1570
1571 <p>When <b>-sbc</b> is used, a block comment with a special leading pattern, <code>##</code> by default, will be treated specially.</p>
1572
1573 <p>Comments so identified are treated as follows:</p>
1574
1575 <ul>
1576
1577 <li><p>If there is no leading space on the line, then the comment will not be indented, and otherwise it may be,</p>
1578
1579 </li>
1580 <li><p>no new blank line will be inserted before such a comment, and</p>
1581
1582 </li>
1583 <li><p>such a comment will never become a hanging side comment.</p>
1584
1585 </li>
1586 </ul>
1587
1588 <p>For example, assuming <code>@month_of_year</code> is left-adjusted:</p>
1589
1590 <pre><code>    @month_of_year = (    # -sbc (default)
1591         &#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;,
1592     ##  &#39;Dec&#39;, &#39;Nov&#39;
1593         &#39;Nov&#39;, &#39;Dec&#39;);</code></pre>
1594
1595 <p>Without this convention, the above code would become</p>
1596
1597 <pre><code>    @month_of_year = (   # -nsbc
1598         &#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;,
1599
1600         ##  &#39;Dec&#39;, &#39;Nov&#39;
1601         &#39;Nov&#39;, &#39;Dec&#39;
1602     );</code></pre>
1603
1604 <p>which is not as clear. The default is to use <b>-sbc</b>. This may be deactivated with <b>-nsbc</b>.</p>
1605
1606 </dd>
1607 <dt id="sbcp-string---static-block-comment-prefix-string"><b>-sbcp=string</b>, <b>--static-block-comment-prefix=string</b></dt>
1608 <dd>
1609
1610 <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>
1611
1612 <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>
1613
1614 <p>A pattern which can be useful is:</p>
1615
1616 <pre><code>    -sbcp=^#{2,}[^\s#]</code></pre>
1617
1618 <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>
1619
1620 </dd>
1621 <dt id="osbc---outdent-static-block-comments"><b>-osbc</b>, <b>--outdent-static-block-comments</b></dt>
1622 <dd>
1623
1624 <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>
1625
1626 </dd>
1627 </dl>
1628
1629 </dd>
1630 <dt id="Static-Side-Comments"><b>Static Side Comments</b></dt>
1631 <dd>
1632
1633 <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>
1634
1635 <dl>
1636
1637 <dt id="ssc---static-side-comments"><b>-ssc</b>, <b>--static-side-comments</b></dt>
1638 <dd>
1639
1640 <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>
1641
1642 <p>The default is <b>-nssc</b>.</p>
1643
1644 </dd>
1645 <dt id="sscp-string---static-side-comment-prefix-string"><b>-sscp=string</b>, <b>--static-side-comment-prefix=string</b></dt>
1646 <dd>
1647
1648 <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>
1649
1650 <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>
1651
1652 </dd>
1653 </dl>
1654
1655 </dd>
1656 </dl>
1657
1658 <h2 id="Skipping-Selected-Sections-of-Code">Skipping Selected Sections of Code</h2>
1659
1660 <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>
1661
1662 <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>
1663
1664 <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>
1665
1666 <pre><code> #&lt;&lt;&lt;  format skipping: do not let perltidy change my nice formatting
1667     my @list = (1,
1668                 1, 1,
1669                 1, 2, 1,
1670                 1, 3, 3, 1,
1671                 1, 4, 6, 4, 1,);
1672  #&gt;&gt;&gt;</code></pre>
1673
1674 <p><b>--code-skipping</b> uses starting and ending markers &#39;#&lt;&lt;V&#39; and &#39;#&gt;&gt;V&#39;, like this:</p>
1675
1676 <pre><code> #&lt;&lt;V  code skipping: perltidy will pass this verbatim without error checking
1677
1678     token ident_digit {
1679         [ [ &lt;?word&gt; | _ | &lt;?digit&gt; ] &lt;?ident_digit&gt;
1680         |   &lt;&#39;&#39;&gt;
1681         ]
1682     };
1683
1684  #&gt;&gt;V</code></pre>
1685
1686 <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>
1687
1688 <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>
1689
1690 <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>
1691
1692 <p>These features should be used sparingly to avoid littering code with markers, but they can be helpful for working around occasional problems.</p>
1693
1694 <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>
1695
1696 <p>The following sections describe the available controls for these options. They should not normally be needed.</p>
1697
1698 <dl>
1699
1700 <dt id="fs---format-skipping"><b>-fs</b>, <b>--format-skipping</b></dt>
1701 <dd>
1702
1703 <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>
1704
1705 <p>Format skipping begins when a format skipping beginning comment is seen and continues until a format-skipping ending comment is found.</p>
1706
1707 <p>This feature can be disabled with <b>-nfs</b>. This should not normally be necessary.</p>
1708
1709 </dd>
1710 <dt id="fsb-string---format-skipping-begin-string"><b>-fsb=string</b>, <b>--format-skipping-begin=string</b></dt>
1711 <dd>
1712
1713 <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>
1714
1715 <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>
1716
1717 <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>
1718
1719 <p>Some examples show how example strings become patterns:</p>
1720
1721 <pre><code> -fsb=&#39;#\{\{\{&#39; becomes /^#\{\{\{\s/  which matches  #{{{ but not #{{{{
1722  -fsb=&#39;#\*\*&#39;   becomes /^#\*\*\s/    which matches  #** but not #***
1723  -fsb=&#39;#\*{2,}&#39; becomes /^#\*{2,}\s/  which matches  #** and #*****</code></pre>
1724
1725 </dd>
1726 <dt id="fse-string---format-skipping-end-string"><b>-fse=string</b>, <b>--format-skipping-end=string</b></dt>
1727 <dd>
1728
1729 <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>
1730
1731 <p>The beginning and ending strings may be the same, but it is preferable to make them different for clarity.</p>
1732
1733 </dd>
1734 <dt id="cs---code-skipping"><b>-cs</b>, <b>--code-skipping</b></dt>
1735 <dd>
1736
1737 <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>
1738
1739 <p>This feature can be disabled with <b>-ncs</b>. This should not normally be necessary.</p>
1740
1741 </dd>
1742 <dt id="csb-string---code-skipping-begin-string"><b>-csb=string</b>, <b>--code-skipping-begin=string</b></dt>
1743 <dd>
1744
1745 <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>
1746
1747 </dd>
1748 <dt id="cse-string---code-skipping-end-string"><b>-cse=string</b>, <b>--code-skipping-end=string</b></dt>
1749 <dd>
1750
1751 <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>
1752
1753 </dd>
1754 </dl>
1755
1756 <h2 id="Line-Break-Control">Line Break Control</h2>
1757
1758 <p>The parameters in this section 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>
1759
1760 <dl>
1761
1762 <dt id="fnl---freeze-newlines"><b>-fnl</b>, <b>--freeze-newlines</b></dt>
1763 <dd>
1764
1765 <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>
1766
1767 <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>
1768
1769 </dd>
1770 <dt id="ce---cuddled-else"><b>-ce</b>, <b>--cuddled-else</b></dt>
1771 <dd>
1772
1773 <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>
1774
1775 <pre><code>  # -ce
1776   if ($task) {
1777       yyy();
1778   } else {
1779       zzz();
1780   }
1781
1782   # -nce (default)
1783   if ($task) {
1784         yyy();
1785   }
1786   else {
1787         zzz();
1788   }</code></pre>
1789
1790 <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>
1791
1792 <p>Other block types can be formatted by specifying their names on a separate parameter <b>-cbl</b>, described in a later section.</p>
1793
1794 <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>
1795
1796 <p>So for example, the <b>-ce</b> flag would not have any effect if the above snippet is rewritten as</p>
1797
1798 <pre><code>  if ($task) { yyy() }
1799   else {    zzz() }</code></pre>
1800
1801 <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>
1802
1803 <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>
1804
1805 </dd>
1806 <dt id="cb---cuddled-blocks"><b>-cb</b>, <b>--cuddled-blocks</b></dt>
1807 <dd>
1808
1809 <p>This flag is equivalent to <b>-ce</b>.</p>
1810
1811 </dd>
1812 <dt id="cbl---cuddled-block-list"><b>-cbl</b>, <b>--cuddled-block-list</b></dt>
1813 <dd>
1814
1815 <p>The built-in default cuddled block types are <b>else, elsif, continue, catch, finally</b>.</p>
1816
1817 <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>
1818
1819 <pre><code>  -cbl=&quot;sort map grep&quot;</code></pre>
1820
1821 <p>or equivalently</p>
1822
1823 <pre><code>  -cbl=sort,map,grep</code></pre>
1824
1825 <p>Note however that these particular block types are typically short so there might not be much opportunity for the cuddled format style.</p>
1826
1827 <p>Using commas avoids the need to protect spaces with quotes.</p>
1828
1829 <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>
1830
1831 <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>
1832
1833 </dd>
1834 <dt id="cblx---cuddled-block-list-exclusive"><b>-cblx</b>, <b>--cuddled-block-list-exclusive</b></dt>
1835 <dd>
1836
1837 <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 among in the defaults, the following set of parameters could be used:</p>
1838
1839 <pre><code>  perltidy -ce -cbl=&#39;else elsif continue&#39; -cblx</code></pre>
1840
1841 </dd>
1842 <dt id="cbo-n---cuddled-break-option-n"><b>-cbo=n</b>, <b>--cuddled-break-option=n</b></dt>
1843 <dd>
1844
1845 <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>
1846
1847 <pre><code>   cbo=0  Never force a short block to break.
1848    cbo=1  If the first of a pair of blocks is broken in the input file,
1849           then break the second [DEFAULT].
1850    cbo=2  Break open all blocks for maximal cuddled formatting.</code></pre>
1851
1852 <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>
1853
1854 <p>The option <b>cbo=0</b> can produce erratic cuddling if there are numerous one-line blocks.</p>
1855
1856 <p>The option <b>cbo=2</b> produces maximal cuddling but will not allow any short blocks.</p>
1857
1858 </dd>
1859 <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>
1860 <dd>
1861
1862 <p>Use the flag <b>-bl</b> to place an opening block brace on a new line:</p>
1863
1864 <pre><code>  if ( $input_file eq &#39;-&#39; )
1865   {
1866       ...
1867   }</code></pre>
1868
1869 <p>By default it applies to all structural blocks except <b>sort map grep eval</b> and anonymous subs.</p>
1870
1871 <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>
1872
1873 <pre><code>  # default
1874   if ( $input_file eq &#39;-&#39; ) {
1875      ...
1876   }</code></pre>
1877
1878 <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>
1879
1880 </dd>
1881 <dt id="bll-s---brace-left-list-s"><b>-bll=s</b>, <b>--brace-left-list=s</b></dt>
1882 <dd>
1883
1884 <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>
1885
1886 </dd>
1887 <dt id="blxl-s---brace-left-exclusion-list-s"><b>-blxl=s</b>, <b>--brace-left-exclusion-list=s</b></dt>
1888 <dd>
1889
1890 <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>
1891
1892 <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>
1893
1894 </dd>
1895 <dt id="sbl---opening-sub-brace-on-new-line"><b>-sbl</b>, <b>--opening-sub-brace-on-new-line</b></dt>
1896 <dd>
1897
1898 <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>
1899
1900 <p>For example,</p>
1901
1902 <pre><code> perltidy -sbl</code></pre>
1903
1904 <p>produces this result:</p>
1905
1906 <pre><code> sub message
1907  {
1908     if (!defined($_[0])) {
1909         print(&quot;Hello, World\n&quot;);
1910     }
1911     else {
1912         print($_[0], &quot;\n&quot;);
1913     }
1914  }</code></pre>
1915
1916 <p>This flag is negated with <b>-nsbl</b>, which is the default.</p>
1917
1918 </dd>
1919 <dt id="asbl---opening-anonymous-sub-brace-on-new-line"><b>-asbl</b>, <b>--opening-anonymous-sub-brace-on-new-line</b></dt>
1920 <dd>
1921
1922 <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>
1923
1924 <pre><code> perltidy -asbl</code></pre>
1925
1926 <p>produces this result:</p>
1927
1928 <pre><code> $a = sub
1929  {
1930      if ( !defined( $_[0] ) ) {
1931          print(&quot;Hello, World\n&quot;);
1932      }
1933      else {
1934          print( $_[0], &quot;\n&quot; );
1935      }
1936  };</code></pre>
1937
1938 <p>This flag is negated with <b>-nasbl</b>, and the default is <b>-nasbl</b>.</p>
1939
1940 </dd>
1941 <dt id="bli---brace-left-and-indent"><b>-bli</b>, <b>--brace-left-and-indent</b></dt>
1942 <dd>
1943
1944 <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>
1945
1946 <p>For example, perltidy -bli gives</p>
1947
1948 <pre><code>        if ( $input_file eq &#39;-&#39; )
1949           {
1950             important_function();
1951           }</code></pre>
1952
1953 <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>
1954
1955 <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>
1956
1957 </dd>
1958 <dt id="blil-s---brace-left-and-indent-list-s"><b>-blil=s</b>, <b>--brace-left-and-indent-list=s</b></dt>
1959 <dd>
1960
1961 <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>
1962
1963 <p>The default is <b>-blil=&#39;if else elsif unless while for foreach do : sub&#39;</b>.</p>
1964
1965 </dd>
1966 <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>
1967 <dd>
1968
1969 <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>
1970
1971 <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>
1972
1973 <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>
1974
1975 </dd>
1976 <dt id="bar---opening-brace-always-on-right"><b>-bar</b>, <b>--opening-brace-always-on-right</b></dt>
1977 <dd>
1978
1979 <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>
1980
1981 <pre><code>        if ( $bigwasteofspace1 &amp;&amp; $bigwasteofspace2
1982           || $bigwasteofspace3 &amp;&amp; $bigwasteofspace4 )
1983         {
1984             big_waste_of_time();
1985         }</code></pre>
1986
1987 <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>
1988
1989 <pre><code>        if ( $bigwasteofspace1 &amp;&amp; $bigwasteofspace2
1990           || $bigwasteofspace3 &amp;&amp; $bigwasteofspace4 ) {
1991             big_waste_of_time();
1992         }</code></pre>
1993
1994 <p>A conflict occurs if both <b>-bl</b> and <b>-bar</b> are specified.</p>
1995
1996 </dd>
1997 <dt id="otr---opening-token-right-and-related-flags"><b>-otr</b>, <b>--opening-token-right</b> and related flags</dt>
1998 <dd>
1999
2000 <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>
2001
2002 <pre><code>    # default formatting
2003     push @{ $self-&gt;{$module}{$key} },
2004       {
2005         accno       =&gt; $ref-&gt;{accno},
2006         description =&gt; $ref-&gt;{description}
2007       };
2008
2009     # perltidy -otr
2010     push @{ $self-&gt;{$module}{$key} }, {
2011         accno       =&gt; $ref-&gt;{accno},
2012         description =&gt; $ref-&gt;{description}
2013       };</code></pre>
2014
2015 <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>
2016
2017 <pre><code>  -opr  or --opening-paren-right
2018   -ohbr or --opening-hash-brace-right
2019   -osbr or --opening-square-bracket-right</code></pre>
2020
2021 </dd>
2022 <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>
2023 <dd>
2024
2025 <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>
2026
2027 <pre><code>    $romanNumerals = {
2028         one   =&gt; &#39;I&#39;,
2029         two   =&gt; &#39;II&#39;,
2030         three =&gt; &#39;III&#39;,
2031         four  =&gt; &#39;IV&#39;,
2032     };</code></pre>
2033
2034 <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>
2035
2036 <pre><code>  -bbhb=0 never break [default]
2037   -bbhb=1 stable: break if the input script had a break
2038   -bbhb=2 break if list is &#39;complex&#39; (see note below)
2039   -bbhb=3 always break</code></pre>
2040
2041 <p>For example,</p>
2042
2043 <pre><code>    # perltidy -bbhb=3
2044     $romanNumerals =
2045       {
2046         one   =&gt; &#39;I&#39;,
2047         two   =&gt; &#39;II&#39;,
2048         three =&gt; &#39;III&#39;,
2049         four  =&gt; &#39;IV&#39;,
2050       };</code></pre>
2051
2052 <p>There are several points to note about this flag:</p>
2053
2054 <ul>
2055
2056 <li><p>This parameter only applies if the opening brace is preceded by an &#39;=&#39; or &#39;=&gt;&#39;.</p>
2057
2058 </li>
2059 <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>
2060
2061 </li>
2062 <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>
2063
2064 </li>
2065 <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>
2066
2067 </li>
2068 <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>
2069
2070 </li>
2071 <li><p>Similar flags for controlling parens and square brackets are given in the subsequent section.</p>
2072
2073 </li>
2074 </ul>
2075
2076 </dd>
2077 <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>
2078 <dd>
2079
2080 <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>
2081
2082 <pre><code>  -bbhbi=0 one continuation level [default]
2083   -bbhbi=1 outdent by one continuation level
2084   -bbhbi=2 indent one full indentation level</code></pre>
2085
2086 <p>For example:</p>
2087
2088 <pre><code>    # perltidy -bbhb=3 -bbhbi=1
2089     $romanNumerals =
2090     {
2091         one   =&gt; &#39;I&#39;,
2092         two   =&gt; &#39;II&#39;,
2093         three =&gt; &#39;III&#39;,
2094         four  =&gt; &#39;IV&#39;,
2095     };
2096
2097     # perltidy -bbhb=3 -bbhbi=2
2098     $romanNumerals =
2099         {
2100         one   =&gt; &#39;I&#39;,
2101         two   =&gt; &#39;II&#39;,
2102         three =&gt; &#39;III&#39;,
2103         four  =&gt; &#39;IV&#39;,
2104         };</code></pre>
2105
2106 <p>Note that this parameter has no effect unless <b>-bbhb=n</b> is also set.</p>
2107
2108 </dd>
2109 <dt id="bbsb-n---break-before-square-bracket-n"><b>-bbsb=n</b>, <b>--break-before-square-bracket=n</b></dt>
2110 <dd>
2111
2112 <p>This flag is similar to the flag described above, except it applies to lists contained within square brackets.</p>
2113
2114 <pre><code>  -bbsb=0 never break [default]
2115   -bbsb=1 stable: break if the input script had a break
2116   -bbsb=2 break if list is &#39;complex&#39; (part of nested list structure)
2117   -bbsb=3 always break</code></pre>
2118
2119 </dd>
2120 <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>
2121 <dd>
2122
2123 <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>
2124
2125 <pre><code>  -bbsbi=0 one continuation level [default]
2126   -bbsbi=1 outdent by one continuation level
2127   -bbsbi=2 indent one full indentation level</code></pre>
2128
2129 </dd>
2130 <dt id="bbp-n---break-before-paren-n"><b>-bbp=n</b>, <b>--break-before-paren=n</b></dt>
2131 <dd>
2132
2133 <p>This flag is similar to <b>-bbhb=n</b>, described above, except it applies to lists contained within parens.</p>
2134
2135 <pre><code>  -bbp=0 never break [default]
2136   -bbp=1 stable: break if the input script had a break
2137   -bpb=2 break if list is &#39;complex&#39; (part of nested list structure)
2138   -bbp=3 always break</code></pre>
2139
2140 </dd>
2141 <dt id="bbpi-n---break-before-paren-and-indent-n"><b>-bbpi=n</b>, <b>--break-before-paren-and-indent=n</b></dt>
2142 <dd>
2143
2144 <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>
2145
2146 <pre><code>  -bbpi=0 one continuation level [default]
2147   -bbpi=1 outdent by one continuation level
2148   -bbpi=2 indent one full indentation level</code></pre>
2149
2150 </dd>
2151 <dt id="wn---weld-nested-containers"><b>-wn</b>, <b>--weld-nested-containers</b></dt>
2152 <dd>
2153
2154 <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>
2155
2156 <p>For example:</p>
2157
2158 <pre><code>        # default formatting
2159         do {
2160             {
2161                 next if $x == $y;
2162             }
2163         } until $x++ &gt; $z;
2164
2165         # perltidy -wn
2166         do { {
2167             next if $x == $y;
2168         } } until $x++ &gt; $z;</code></pre>
2169
2170 <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.</p>
2171
2172 <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>
2173
2174 <pre><code>        # default formatting
2175         my (@date_time) = Localtime(
2176             Date_to_Time(
2177                 Add_Delta_DHMS(
2178                     $year, $month,  $day, $hour, $minute, $second,
2179                     &#39;0&#39;,   $offset, &#39;0&#39;,  &#39;0&#39;
2180                 )
2181             )
2182         );
2183
2184         # perltidy -wn
2185         my (@date_time) = Localtime( Date_to_Time( Add_Delta_DHMS(
2186             $year, $month,  $day, $hour, $minute, $second,
2187             &#39;0&#39;,   $offset, &#39;0&#39;,  &#39;0&#39;
2188         ) ) );</code></pre>
2189
2190 <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>
2191
2192 <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>
2193
2194 <p>Here is an example illustrating a welded container within a welded containers:</p>
2195
2196 <pre><code>        # default formatting
2197         $x-&gt;badd(
2198             bmul(
2199                 $class-&gt;new(
2200                     abs(
2201                         $sx * int( $xr-&gt;numify() ) &amp; $sy * int( $yr-&gt;numify() )
2202                     )
2203                 ),
2204                 $m
2205             )
2206         );
2207
2208         # perltidy -wn
2209         $x-&gt;badd( bmul(
2210             $class-&gt;new( abs(
2211                 $sx * int( $xr-&gt;numify() ) &amp; $sy * int( $yr-&gt;numify() )
2212             ) ),
2213             $m
2214         ) );</code></pre>
2215
2216 <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>
2217
2218 <pre><code>        # perltidy -wn -vtc=2
2219         $x-&gt;badd( bmul(
2220             $class-&gt;new( abs(
2221                 $sx * int( $xr-&gt;numify() ) &amp; $sy * int( $yr-&gt;numify() ) ) ),
2222             $m ) );</code></pre>
2223
2224 <p>This format option is quite general but there are some limitations.</p>
2225
2226 <p>One limitation is that any line length limit still applies and can cause long welded sections to be broken into multiple lines.</p>
2227
2228 <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>
2229
2230 <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>
2231
2232 </dd>
2233 <dt id="wnxl-s---weld-nested-exclusion-list"><b>-wnxl=s</b>, <b>--weld-nested-exclusion-list</b></dt>
2234 <dd>
2235
2236 <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>
2237
2238 <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>
2239
2240 <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>
2241
2242 <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>
2243
2244 <pre><code>  -wnxl=&#39;[ { q&#39;</code></pre>
2245
2246 <p>means do <b>NOT</b> include square-bracets, 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>
2247
2248 <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>
2249
2250 <pre><code>    # perltidy -wn
2251     skip_symbols( [ qw(
2252         Perl_dump_fds
2253         Perl_ErrorNo
2254         Perl_GetVars
2255         PL_sys_intern
2256     ) ] );</code></pre>
2257
2258 <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>
2259
2260 <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>
2261
2262 <p>For example, if we do not want a sequence of welded containers to start with a square bracket we could use</p>
2263
2264 <pre><code>  -wnxl=&#39;^[&#39;</code></pre>
2265
2266 <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>
2267
2268 <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>
2269
2270 <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;),
2271  &#39;K&#39; matches if &#39;k&#39; does not, meaning that the previous token is not a keyword.
2272  &#39;f&#39; matches if the previous token is a function other than a keyword.
2273  &#39;F&#39; matches if &#39;f&#39; does not.
2274  &#39;w&#39; matches if either &#39;k&#39; or &#39;f&#39; match.
2275  &#39;W&#39; matches if &#39;w&#39; does not.</code></pre>
2276
2277 <p>For example, compare</p>
2278
2279 <pre><code>        # perltidy -wn
2280         if ( defined( $_Cgi_Query{
2281             $Config{&#39;methods&#39;}{&#39;authentication&#39;}{&#39;remote&#39;}{&#39;cgi&#39;}{&#39;username&#39;}
2282         } ) )</code></pre>
2283
2284 <p>with</p>
2285
2286 <pre><code>        # perltidy -wn -wnxl=&#39;^K( {&#39;
2287         if ( defined(
2288             $_Cgi_Query{ $Config{&#39;methods&#39;}{&#39;authentication&#39;}{&#39;remote&#39;}{&#39;cgi&#39;}
2289                   {&#39;username&#39;} }
2290         ) )</code></pre>
2291
2292 <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>
2293
2294 <p>Here are some additional example strings and their meanings:</p>
2295
2296 <pre><code>    &#39;^(&#39;   - the weld must not start with a paren
2297     &#39;.(&#39;   - the second and later tokens may not be parens
2298     &#39;.w(&#39;  - the second and later tokens may not keyword or function call parens
2299     &#39;(&#39;    - no parens in a weld
2300     &#39;^K(&#39;  - exclude a leading paren preceded by a non-keyword
2301     &#39;.k(&#39;  - exclude a secondary paren preceded by a keyword
2302     &#39;[ {&#39;  - exclude all brackets and braces
2303     &#39;[ ( ^K{&#39; - exclude everything except nested structures like do {{  ... }}</code></pre>
2304
2305 </dd>
2306 <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>
2307 <dd>
2308
2309 <p>These parameters control what shall be called vertical tightness. Here are the main points:</p>
2310
2311 <ul>
2312
2313 <li><p>Opening tokens (except for block braces) are controlled by <b>-vt=n</b>, or <b>--vertical-tightness=n</b>, where</p>
2314
2315 <pre><code> -vt=0 always break a line after opening token (default).
2316  -vt=1 do not break unless this would produce more than one
2317          step in indentation in a line.
2318  -vt=2 never break a line after opening token</code></pre>
2319
2320 </li>
2321 <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>
2322
2323 </li>
2324 <li><p>Closing tokens (except for block braces) are controlled by <b>-vtc=n</b>, or <b>--vertical-tightness-closing=n</b>, where</p>
2325
2326 <pre><code> -vtc=0 always break a line before a closing token (default),
2327  -vtc=1 do not break before a closing token which is followed
2328         by a semicolon or another closing token, and is not in
2329         a list environment.
2330  -vtc=2 never break before a closing token.
2331  -vtc=3 Like -vtc=1 except always break before a closing token
2332         if the corresponding opening token follows an = or =&gt;.</code></pre>
2333
2334 <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>
2335
2336 </li>
2337 <li><p>Different controls may be applied to different token types, and it is also possible to control block braces; see below.</p>
2338
2339 </li>
2340 <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>
2341
2342 </li>
2343 </ul>
2344
2345 <p>Here are some examples:</p>
2346
2347 <pre><code>    # perltidy -lp -vt=0 -vtc=0
2348     %romanNumerals = (
2349                        one   =&gt; &#39;I&#39;,
2350                        two   =&gt; &#39;II&#39;,
2351                        three =&gt; &#39;III&#39;,
2352                        four  =&gt; &#39;IV&#39;,
2353     );
2354
2355     # perltidy -lp -vt=1 -vtc=0
2356     %romanNumerals = ( one   =&gt; &#39;I&#39;,
2357                        two   =&gt; &#39;II&#39;,
2358                        three =&gt; &#39;III&#39;,
2359                        four  =&gt; &#39;IV&#39;,
2360     );
2361
2362     # perltidy -lp -vt=1 -vtc=1
2363     %romanNumerals = ( one   =&gt; &#39;I&#39;,
2364                        two   =&gt; &#39;II&#39;,
2365                        three =&gt; &#39;III&#39;,
2366                        four  =&gt; &#39;IV&#39;, );
2367
2368     # perltidy -vtc=3
2369     my_function(
2370         one   =&gt; &#39;I&#39;,
2371         two   =&gt; &#39;II&#39;,
2372         three =&gt; &#39;III&#39;,
2373         four  =&gt; &#39;IV&#39;, );
2374
2375     # perltidy -vtc=3
2376     %romanNumerals = (
2377         one   =&gt; &#39;I&#39;,
2378         two   =&gt; &#39;II&#39;,
2379         three =&gt; &#39;III&#39;,
2380         four  =&gt; &#39;IV&#39;,
2381     );</code></pre>
2382
2383 <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>
2384
2385 <p>The difference between <b>-vt=1</b> and <b>-vt=2</b> is shown here:</p>
2386
2387 <pre><code>    # perltidy -lp -vt=1
2388     $init-&gt;add(
2389                 mysprintf( &quot;(void)find_threadsv(%s);&quot;,
2390                            cstring( $threadsv_names[ $op-&gt;targ ] )
2391                 )
2392     );
2393
2394     # perltidy -lp -vt=2
2395     $init-&gt;add( mysprintf( &quot;(void)find_threadsv(%s);&quot;,
2396                            cstring( $threadsv_names[ $op-&gt;targ ] )
2397                 )
2398     );</code></pre>
2399
2400 <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>
2401
2402 <p>The tightest, and least readable, code is produced with both <code>-vt=2</code> and <code>-vtc=2</code>:</p>
2403
2404 <pre><code>    # perltidy -lp -vt=2 -vtc=2
2405     $init-&gt;add( mysprintf( &quot;(void)find_threadsv(%s);&quot;,
2406                            cstring( $threadsv_names[ $op-&gt;targ ] ) ) );</code></pre>
2407
2408 <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>
2409
2410 <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>
2411
2412 <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>
2413
2414 <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>
2415
2416 <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>
2417
2418 <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>
2419
2420 </dd>
2421 <dt id="bbvt-n-or---block-brace-vertical-tightness-n"><b>-bbvt=n</b> or <b>--block-brace-vertical-tightness=n</b></dt>
2422 <dd>
2423
2424 <p>The <b>-bbvt=n</b> flag is just like the <b>-vt=n</b> flag but applies to opening code block braces.</p>
2425
2426 <pre><code> -bbvt=0 break after opening block brace (default).
2427  -bbvt=1 do not break unless this would produce more than one
2428          step in indentation in a line.
2429  -bbvt=2 do not break after opening block brace.</code></pre>
2430
2431 <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>
2432
2433 <pre><code>    # perltidy -bli -bbvt=0
2434     if ( open( FILE, &quot;&lt; $File&quot; ) )
2435       {
2436         while ( $File = &lt;FILE&gt; )
2437           {
2438             $In .= $File;
2439             $count++;
2440           }
2441         close(FILE);
2442       }
2443
2444     # perltidy -bli -bbvt=1
2445     if ( open( FILE, &quot;&lt; $File&quot; ) )
2446       { while ( $File = &lt;FILE&gt; )
2447           { $In .= $File;
2448             $count++;
2449           }
2450         close(FILE);
2451       }</code></pre>
2452
2453 <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>
2454
2455 <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>
2456
2457 <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>
2458
2459 </dd>
2460 <dt id="sot---stack-opening-tokens-and-related-flags"><b>-sot</b>, <b>--stack-opening-tokens</b> and related flags</dt>
2461 <dd>
2462
2463 <p>The <b>-sot</b> flag tells perltidy to &quot;stack&quot; opening tokens when possible to avoid lines with isolated opening tokens.</p>
2464
2465 <p>For example:</p>
2466
2467 <pre><code>    # default
2468     $opt_c = Text::CSV_XS-&gt;new(
2469         {
2470             binary       =&gt; 1,
2471             sep_char     =&gt; $opt_c,
2472             always_quote =&gt; 1,
2473         }
2474     );
2475
2476     # -sot
2477     $opt_c = Text::CSV_XS-&gt;new( {
2478             binary       =&gt; 1,
2479             sep_char     =&gt; $opt_c,
2480             always_quote =&gt; 1,
2481         }
2482     );</code></pre>
2483
2484 <p>For detailed control of individual closing tokens the following controls can be used:</p>
2485
2486 <pre><code>  -sop  or --stack-opening-paren
2487   -sohb or --stack-opening-hash-brace
2488   -sosb or --stack-opening-square-bracket
2489   -sobb or --stack-opening-block-brace</code></pre>
2490
2491 <p>The flag <b>-sot</b> is an abbreviation for <b>-sop -sohb -sosb</b>.</p>
2492
2493 <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>
2494
2495 </dd>
2496 <dt id="sct---stack-closing-tokens-and-related-flags"><b>-sct</b>, <b>--stack-closing-tokens</b> and related flags</dt>
2497 <dd>
2498
2499 <p>The <b>-sct</b> flag tells perltidy to &quot;stack&quot; closing tokens when possible to avoid lines with isolated closing tokens.</p>
2500
2501 <p>For example:</p>
2502
2503 <pre><code>    # default
2504     $opt_c = Text::CSV_XS-&gt;new(
2505         {
2506             binary       =&gt; 1,
2507             sep_char     =&gt; $opt_c,
2508             always_quote =&gt; 1,
2509         }
2510     );
2511
2512     # -sct
2513     $opt_c = Text::CSV_XS-&gt;new(
2514         {
2515             binary       =&gt; 1,
2516             sep_char     =&gt; $opt_c,
2517             always_quote =&gt; 1,
2518         } );</code></pre>
2519
2520 <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>
2521
2522 <pre><code>    # -vtc=2
2523     $opt_c = Text::CSV_XS-&gt;new(
2524         {
2525             binary       =&gt; 1,
2526             sep_char     =&gt; $opt_c,
2527             always_quote =&gt; 1, } );</code></pre>
2528
2529 <p>For detailed control of the stacking of individual closing tokens the following controls can be used:</p>
2530
2531 <pre><code>  -scp  or --stack-closing-paren
2532   -schb or --stack-closing-hash-brace
2533   -scsb or --stack-closing-square-bracket
2534   -scbb or --stack-closing-block-brace</code></pre>
2535
2536 <p>The flag <b>-sct</b> is an abbreviation for stacking the non-block closing tokens, <b>-scp -schb -scsb</b>.</p>
2537
2538 <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>
2539
2540 <pre><code>    # -scbb:
2541     for $w1 (@w1) {
2542         for $w2 (@w2) {
2543             for $w3 (@w3) {
2544                 for $w4 (@w4) {
2545                     push( @lines, &quot;$w1 $w2 $w3 $w4\n&quot; );
2546                 } } } }</code></pre>
2547
2548 <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>
2549
2550 <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>
2551
2552 </dd>
2553 <dt id="dnl---delete-old-newlines"><b>-dnl</b>, <b>--delete-old-newlines</b></dt>
2554 <dd>
2555
2556 <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>
2557
2558 </dd>
2559 <dt id="anl---add-newlines"><b>-anl</b>, <b>--add-newlines</b></dt>
2560 <dd>
2561
2562 <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>
2563
2564 <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>
2565
2566 </dd>
2567 <dt id="Controlling-whether-perltidy-breaks-before-or-after-operators"><b>Controlling whether perltidy breaks before or after operators</b></dt>
2568 <dd>
2569
2570 <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>
2571
2572 <p><b>-wba=s</b> or <b>--want-break-after=s</b>, and</p>
2573
2574 <p><b>-wbb=s</b> or <b>--want-break-before=s</b>.</p>
2575
2576 <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>
2577
2578 <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>
2579
2580 <p>And perltidy breaks <b>before</b> these token types by default: . &lt;&lt; &gt;&gt; -&gt; &amp;&amp; || //</p>
2581
2582 <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>
2583
2584 <pre><code>  -wba=&quot;.&quot;</code></pre>
2585
2586 <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>
2587
2588 <pre><code>  -wbb=&quot;+ - / *&quot;</code></pre>
2589
2590 <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>
2591
2592 <p><b>WARNING</b> Be sure to put these tokens in quotes to avoid having them misinterpreted by your command shell.</p>
2593
2594 <p>Two additional parameters are available which, though they provide no further capability, can simplify input are:</p>
2595
2596 <p><b>-baao</b> or <b>--break-after-all-operators</b>,</p>
2597
2598 <p><b>-bbao</b> or <b>--break-before-all-operators</b>.</p>
2599
2600 <p>The -baao sets the default to be to break after all of the following operators:</p>
2601
2602 <pre><code>    % + - * / x != == &gt;= &lt;= =~ !~ &lt; &gt; | &amp;
2603     = **= += *= &amp;= &lt;&lt;= &amp;&amp;= -= /= |= &gt;&gt;= ||= //= .= %= ^= x=
2604     . : ? &amp;&amp; || and or err xor</code></pre>
2605
2606 <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>
2607
2608 </dd>
2609 <dt id="bal-n---break-after-labels-n"><b>bal=n, --break-after-labels=n</b></dt>
2610 <dd>
2611
2612 <p>This flag controls whether or not a line break occurs after a label. There are three possible values for <b>n</b>:</p>
2613
2614 <pre><code>  -bal=0  break if there is a break in the input [DEFAULT]
2615   -bal=1  always break after a label
2616   -bal=2  never break after a label</code></pre>
2617
2618 <p>For example,</p>
2619
2620 <pre><code>      # perltidy -bal=1
2621       RETURN:
2622         return;
2623
2624       # perltidy -bal=2
2625       RETURN: return;</code></pre>
2626
2627 </dd>
2628 </dl>
2629
2630 <h2 id="Controlling-List-Formatting">Controlling List Formatting</h2>
2631
2632 <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>
2633
2634 <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>
2635
2636 <pre><code>    my @list = (1,
2637                 1, 1,
2638                 1, 2, 1,
2639                 1, 3, 3, 1,
2640                 1, 4, 6, 4, 1,);</code></pre>
2641
2642 <p>The default formatting, which allows a maximum line length of 80, will flatten this down to one line:</p>
2643
2644 <pre><code>    # perltidy (default)
2645     my @list = ( 1, 1, 1, 1, 2, 1, 1, 3, 3, 1, 1, 4, 6, 4, 1, );</code></pre>
2646
2647 <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>
2648
2649 <pre><code>    my @list = (
2650         1,    # a side comment forces the original line breakpoints to be kept
2651         1, 1,
2652         1, 2, 1,
2653         1, 3, 3, 1,
2654         1, 4, 6, 4, 1,
2655     );</code></pre>
2656
2657 <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>
2658
2659 <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>
2660
2661 <dl>
2662
2663 <dt id="boc---break-at-old-comma-breakpoints"><b>-boc</b>, <b>--break-at-old-comma-breakpoints</b></dt>
2664 <dd>
2665
2666 <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>
2667
2668 <pre><code>    # perltidy -boc -lp -pt=2 -vt=1 -vtc=1
2669     my @list = (1,
2670                 1, 1,
2671                 1, 2, 1,
2672                 1, 3, 3, 1,
2673                 1, 4, 6, 4, 1,);</code></pre>
2674
2675 <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>
2676
2677 </dd>
2678 <dt id="mft-n---maximum-fields-per-table-n"><b>-mft=n</b>, <b>--maximum-fields-per-table=n</b></dt>
2679 <dd>
2680
2681 <p>If the computed number of fields for any table exceeds <b>n</b>, then it will be reduced to <b>n</b>. The default value for <b>n</b> is a large number, 40. While this value should probably be left unchanged as a general rule, it 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.</p>
2682
2683 <pre><code>    # perltidy -mft=2
2684     @month_of_year = (
2685         &#39;Jan&#39;, &#39;Feb&#39;,
2686         &#39;Mar&#39;, &#39;Apr&#39;,
2687         &#39;May&#39;, &#39;Jun&#39;,
2688         &#39;Jul&#39;, &#39;Aug&#39;,
2689         &#39;Sep&#39;, &#39;Oct&#39;,
2690         &#39;Nov&#39;, &#39;Dec&#39;
2691     );</code></pre>
2692
2693 </dd>
2694 <dt id="cab-n---comma-arrow-breakpoints-n"><b>-cab=n</b>, <b>--comma-arrow-breakpoints=n</b></dt>
2695 <dd>
2696
2697 <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>
2698
2699 <pre><code> n=0 break at all commas after =&gt;
2700  n=1 stable: break at all commas after =&gt; if container is open,
2701      EXCEPT FOR one-line containers
2702  n=2 break at all commas after =&gt;, BUT try to form the maximum
2703      one-line container lengths
2704  n=3 do not treat commas after =&gt; specially at all
2705  n=4 break everything: like n=0 but ALSO break a short container with
2706      a =&gt; not followed by a comma when -vt=0 is used
2707  n=5 stable: like n=1 but ALSO break at open one-line containers when
2708      -vt=0 is used (default)</code></pre>
2709
2710 <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>
2711
2712 <pre><code>    bless { B =&gt; $B, Root =&gt; $Root } =&gt; $package;</code></pre>
2713
2714 <p>Using <b>-cab=0</b> will force a break after each comma-arrow item:</p>
2715
2716 <pre><code>    # perltidy -cab=0:
2717     bless {
2718         B    =&gt; $B,
2719         Root =&gt; $Root
2720     } =&gt; $package;</code></pre>
2721
2722 <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>
2723
2724 <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>
2725
2726 <pre><code>    # perltidy -cab=3
2727     my %last_day = (
2728         &quot;01&quot; =&gt; 31, &quot;02&quot; =&gt; 29, &quot;03&quot; =&gt; 31, &quot;04&quot; =&gt; 30,
2729         &quot;05&quot; =&gt; 31, &quot;06&quot; =&gt; 30, &quot;07&quot; =&gt; 31, &quot;08&quot; =&gt; 31,
2730         &quot;09&quot; =&gt; 30, &quot;10&quot; =&gt; 31, &quot;11&quot; =&gt; 30, &quot;12&quot; =&gt; 31
2731     );</code></pre>
2732
2733 </dd>
2734 </dl>
2735
2736 <h2 id="Retaining-or-Ignoring-Existing-Line-Breaks">Retaining or Ignoring Existing Line Breaks</h2>
2737
2738 <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>
2739
2740 <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>
2741
2742 <dl>
2743
2744 <dt id="bol---break-at-old-logical-breakpoints"><b>-bol</b>, <b>--break-at-old-logical-breakpoints</b></dt>
2745 <dd>
2746
2747 <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>
2748
2749 <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>
2750
2751 <p>For example, given this snippet:</p>
2752
2753 <pre><code>    return unless $cmd = $cmd || ($dot
2754         &amp;&amp; $Last_Shell) || &amp;prompt(&#39;|&#39;);
2755
2756     # perltidy -bol [default]
2757     return
2758       unless $cmd = $cmd
2759       || ( $dot
2760         &amp;&amp; $Last_Shell )
2761       || &amp;prompt(&#39;|&#39;);
2762
2763     # perltidy -nbol
2764     return unless $cmd = $cmd || ( $dot &amp;&amp; $Last_Shell ) || &amp;prompt(&#39;|&#39;);</code></pre>
2765
2766 </dd>
2767 <dt id="bom---break-at-old-method-breakpoints"><b>-bom</b>, <b>--break-at-old-method-breakpoints</b></dt>
2768 <dd>
2769
2770 <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 preformatted a method chain:</p>
2771
2772 <pre><code>  my $q = $rs
2773     -&gt;related_resultset(&#39;CDs&#39;)
2774     -&gt;related_resultset(&#39;Tracks&#39;)
2775     -&gt;search({
2776       &#39;track.id&#39; =&gt; {-ident =&gt; &#39;none_search.id&#39;},
2777     })-&gt;as_query;</code></pre>
2778
2779 <p>It will <b>keep</b> these breaks, rather than become this:</p>
2780
2781 <pre><code>  my $q = $rs-&gt;related_resultset(&#39;CDs&#39;)-&gt;related_resultset(&#39;Tracks&#39;)-&gt;search({
2782       &#39;track.id&#39; =&gt; {-ident =&gt; &#39;none_search.id&#39;},
2783     })-&gt;as_query;</code></pre>
2784
2785 <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>
2786
2787 <pre><code>  # perltidy -bom -wn
2788   my $q = $rs-&gt;related_resultset(
2789       &#39;CDs&#39;
2790   )-&gt;related_resultset(
2791       &#39;Tracks&#39;
2792   )-&gt;search( {
2793       &#39;track.id&#39; =&gt; { -ident =&gt; &#39;none_search.id&#39; },
2794   } )-&gt;as_query;</code></pre>
2795
2796 <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>
2797
2798 </dd>
2799 <dt id="bos---break-at-old-semicolon-breakpoints"><b>-bos</b>, <b>--break-at-old-semicolon-breakpoints</b></dt>
2800 <dd>
2801
2802 <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>
2803
2804 <pre><code>  $z = sqrt($x**2 + $y**2)
2805   ;</code></pre>
2806
2807 <p>The default formatting will be:</p>
2808
2809 <pre><code>  $z = sqrt( $x**2 + $y**2 );</code></pre>
2810
2811 <p>The result using <b>perltidy -bos</b> keeps the isolated semicolon:</p>
2812
2813 <pre><code>  $z = sqrt( $x**2 + $y**2 )
2814     ;</code></pre>
2815
2816 <p>The default is not to do this, <b>-nbos</b>.</p>
2817
2818 </dd>
2819 <dt id="bok---break-at-old-keyword-breakpoints"><b>-bok</b>, <b>--break-at-old-keyword-breakpoints</b></dt>
2820 <dd>
2821
2822 <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>
2823
2824 </dd>
2825 <dt id="bot---break-at-old-ternary-breakpoints"><b>-bot</b>, <b>--break-at-old-ternary-breakpoints</b></dt>
2826 <dd>
2827
2828 <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>
2829
2830 </dd>
2831 <dt id="boa---break-at-old-attribute-breakpoints"><b>-boa</b>, <b>--break-at-old-attribute-breakpoints</b></dt>
2832 <dd>
2833
2834 <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>
2835
2836 <pre><code>                    my @field
2837                       : field
2838                       : Default(1)
2839                       : Get(&#39;Name&#39; =&gt; &#39;foo&#39;) : Set(&#39;Name&#39;);</code></pre>
2840
2841 <p>If the attributes are on a single line in the source code then they will remain on a single line if possible.</p>
2842
2843 <p>To prevent this, and thereby always form longer lines, use <b>-nboa</b>.</p>
2844
2845 </dd>
2846 <dt id="Keeping-old-breakpoints-at-specific-token-types"><b>Keeping old breakpoints at specific token types</b></dt>
2847 <dd>
2848
2849 <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>
2850
2851 <p><b>-kbb=s</b> or <b>--keep-old-breakpoints-before=s</b>, and</p>
2852
2853 <p><b>-kba=s</b> or <b>--keep-old-breakpoints-after=s</b></p>
2854
2855 <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>
2856
2857 <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>
2858
2859 <p>For example, given the script:</p>
2860
2861 <pre><code>    method &#39;foo&#39;
2862       =&gt; [ Int, Int ]
2863       =&gt; sub {
2864         my ( $self, $x, $y ) = ( shift, @_ );
2865         ...;
2866       };
2867
2868     # perltidy [default]
2869     method &#39;foo&#39; =&gt; [ Int, Int ] =&gt; sub {
2870         my ( $self, $x, $y ) = ( shift, @_ );
2871         ...;
2872     };
2873
2874     # perltidy -kbb=&#39;=&gt;&#39;
2875     method &#39;foo&#39;
2876       =&gt; [ Int, Int ]
2877       =&gt; sub {
2878         my ( $self, $x, $y ) = ( shift, @_ );
2879         ...;
2880       };</code></pre>
2881
2882 <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>
2883
2884 <pre><code>   perltidy -kba=&#39;(&#39;</code></pre>
2885
2886 <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>
2887
2888 <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;),
2889  &#39;K&#39; matches if &#39;k&#39; does not, meaning that the previous token is not a keyword.
2890  &#39;f&#39; matches if the previous token is a function other than a keyword.
2891  &#39;F&#39; matches if &#39;f&#39; does not.
2892  &#39;w&#39; matches if either &#39;k&#39; or &#39;f&#39; match.
2893  &#39;W&#39; matches if &#39;w&#39; does not.</code></pre>
2894
2895 <p>So for example the the following parameter will keep breaks after opening function call parens:</p>
2896
2897 <pre><code>   perltidy -kba=&#39;f(&#39;</code></pre>
2898
2899 <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>
2900
2901 </dd>
2902 <dt id="iob---ignore-old-breakpoints"><b>-iob</b>, <b>--ignore-old-breakpoints</b></dt>
2903 <dd>
2904
2905 <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>
2906
2907 <p>To illustrate, consider the following input text:</p>
2908
2909 <pre><code>    has subcmds =&gt; (
2910         is =&gt; &#39;ro&#39;,
2911         default =&gt; sub { [] },
2912     );</code></pre>
2913
2914 <p>The default formatting will keep the container broken, giving</p>
2915
2916 <pre><code>    # perltidy [default]
2917     has subcmds =&gt; (
2918         is      =&gt; &#39;ro&#39;,
2919         default =&gt; sub { [] },
2920     );</code></pre>
2921
2922 <p>If old breakpoints are ignored, the list will be flattened:</p>
2923
2924 <pre><code>    # perltidy -iob
2925     has subcmds =&gt; ( is =&gt; &#39;ro&#39;, default =&gt; sub { [] }, );</code></pre>
2926
2927 <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>
2928
2929 <p>Even if this is parameter is not used globally, it provides a convenient way to flatten selected lists from within an editor.</p>
2930
2931 </dd>
2932 <dt id="kis---keep-interior-semicolons"><b>-kis</b>, <b>--keep-interior-semicolons</b></dt>
2933 <dd>
2934
2935 <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>
2936
2937 <pre><code>    dbmclose(%verb_delim); undef %verb_delim;
2938     dbmclose(%expanded); undef %expanded;</code></pre>
2939
2940 <p>The default is to break after each statement, giving</p>
2941
2942 <pre><code>    dbmclose(%verb_delim);
2943     undef %verb_delim;
2944     dbmclose(%expanded);
2945     undef %expanded;</code></pre>
2946
2947 <p>With <b>perltidy -kis</b> the multiple statements are retained:</p>
2948
2949 <pre><code>    dbmclose(%verb_delim); undef %verb_delim;
2950     dbmclose(%expanded);   undef %expanded;</code></pre>
2951
2952 <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>
2953
2954 </dd>
2955 </dl>
2956
2957 <h2 id="Blank-Line-Control">Blank Line Control</h2>
2958
2959 <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>
2960
2961 <dl>
2962
2963 <dt id="fbl---freeze-blank-lines"><b>-fbl</b>, <b>--freeze-blank-lines</b></dt>
2964 <dd>
2965
2966 <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>
2967
2968 </dd>
2969 <dt id="bbc---blanks-before-comments"><b>-bbc</b>, <b>--blanks-before-comments</b></dt>
2970 <dd>
2971
2972 <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>
2973
2974 </dd>
2975 <dt id="blbs-n---blank-lines-before-subs-n"><b>-blbs=n</b>, <b>--blank-lines-before-subs=n</b></dt>
2976 <dd>
2977
2978 <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>
2979
2980 <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>
2981
2982 <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>
2983
2984 <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>
2985
2986 <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>
2987
2988 <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>
2989
2990 </dd>
2991 <dt id="blbp-n---blank-lines-before-packages-n"><b>-blbp=n</b>, <b>--blank-lines-before-packages=n</b></dt>
2992 <dd>
2993
2994 <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>
2995
2996 <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>
2997
2998 </dd>
2999 <dt id="bbs---blanks-before-subs"><b>-bbs</b>, <b>--blanks-before-subs</b></dt>
3000 <dd>
3001
3002 <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>
3003
3004 <p>Likewise, <b>-nbbs</b> or <b>--noblanks-before-subs</b> is equivalent to <i>-blbp=0</i> and <i>-blbs=0</i>.</p>
3005
3006 </dd>
3007 <dt id="bbb---blanks-before-blocks"><b>-bbb</b>, <b>--blanks-before-blocks</b></dt>
3008 <dd>
3009
3010 <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>
3011
3012 <ul>
3013
3014 <li><p>The block is not preceded by a comment.</p>
3015
3016 </li>
3017 <li><p>The block is not a one-line block.</p>
3018
3019 </li>
3020 <li><p>The number of consecutive non-blank lines at the current indentation depth is at least <b>-lbl</b> (see next section).</p>
3021
3022 </li>
3023 </ul>
3024
3025 <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>
3026
3027 </dd>
3028 <dt id="lbl-n---long-block-line-count-n"><b>-lbl=n</b> <b>--long-block-line-count=n</b></dt>
3029 <dd>
3030
3031 <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>
3032
3033 </dd>
3034 <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>
3035 <dd>
3036
3037 <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>
3038
3039 <p>Please see the note below on using the <b>-blao</b> and <b>-blbc</b> options.</p>
3040
3041 </dd>
3042 <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>
3043 <dd>
3044
3045 <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>
3046
3047 </dd>
3048 <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>
3049 <dd>
3050
3051 <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>
3052
3053 </dd>
3054 <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>
3055 <dd>
3056
3057 <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>
3058
3059 </dd>
3060 <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>
3061 <dd>
3062
3063 <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>
3064
3065 <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>
3066
3067 <pre><code>  perltidy -blao=2 -blbc=2 -blaol=&#39;*&#39; -blbcl=&#39;*&#39; filename</code></pre>
3068
3069 <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>
3070
3071 <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>
3072
3073 </dd>
3074 <dt id="mbl-n---maximum-consecutive-blank-lines-n"><b>-mbl=n</b> <b>--maximum-consecutive-blank-lines=n</b></dt>
3075 <dd>
3076
3077 <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>
3078
3079 <p>This flag obviously does not apply to pod sections, here-documents, and quotes.</p>
3080
3081 </dd>
3082 <dt id="kbl-n---keep-old-blank-lines-n"><b>-kbl=n</b>, <b>--keep-old-blank-lines=n</b></dt>
3083 <dd>
3084
3085 <p>The <b>-kbl=n</b> flag gives you control over how your existing blank lines are treated.</p>
3086
3087 <p>The possible values of <b>n</b> are:</p>
3088
3089 <pre><code> n=0 ignore all old blank lines
3090  n=1 stable: keep old blanks, but limited by the value of the B&lt;-mbl=n&gt; flag
3091  n=2 keep all old blank lines, regardless of the value of the B&lt;-mbl=n&gt; flag</code></pre>
3092
3093 <p>The default is <b>n=1</b>.</p>
3094
3095 </dd>
3096 <dt id="sob---swallow-optional-blank-lines"><b>-sob</b>, <b>--swallow-optional-blank-lines</b></dt>
3097 <dd>
3098
3099 <p>This is equivalent to <b>kbl=0</b> and is included for compatibility with previous versions.</p>
3100
3101 </dd>
3102 <dt id="nsob---noswallow-optional-blank-lines"><b>-nsob</b>, <b>--noswallow-optional-blank-lines</b></dt>
3103 <dd>
3104
3105 <p>This is equivalent to <b>kbl=1</b> and is included for compatibility with previous versions.</p>
3106
3107 </dd>
3108 </dl>
3109
3110 <p><b>Controls for blank lines around lines of consecutive keywords</b></p>
3111
3112 <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>
3113
3114 <p><b>-kgbl=s</b> or <b>--keyword-group-blanks-list=s</b>; <b>s</b> is a quoted string of keywords</p>
3115
3116 <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>
3117
3118 <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>
3119
3120 <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>
3121
3122 <p><b>-kgbi</b> or <b>--keyword-group-blanks-inside</b> is a switch for adding blanks between subgroups</p>
3123
3124 <p><b>-kgbd</b> or <b>--keyword-group-blanks-delete</b> is a switch for removing initial blank lines between keywords</p>
3125
3126 <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>
3127
3128 <p>In addition, the following abbreviations are available to for simplified usage:</p>
3129
3130 <p><b>-kgb</b> or <b>--keyword-group-blanks</b> is short for <b>-kgbb=2 -kgba=2 kgbi</b></p>
3131
3132 <p><b>-nkgb</b> or <b>--nokeyword-group-blanks</b>, is short for <b>-kgbb=1 -kgba=1 nkgbi</b></p>
3133
3134 <p>Before describing the meaning of the parameters in detail let us look at an example which is formatted with default parameter settings.</p>
3135
3136 <pre><code>        print &quot;Entering test 2\n&quot;;
3137         use Test;
3138         use Encode qw(from_to encode decode
3139           encode_utf8 decode_utf8
3140           find_encoding is_utf8);
3141         use charnames qw(greek);
3142         my @encodings     = grep( /iso-?8859/, Encode::encodings() );
3143         my @character_set = ( &#39;0&#39; .. &#39;9&#39;, &#39;A&#39; .. &#39;Z&#39;, &#39;a&#39; .. &#39;z&#39; );
3144         my @source        = qw(ascii iso8859-1 cp1250);
3145         my @destiny       = qw(cp1047 cp37 posix-bc);
3146         my @ebcdic_sets   = qw(cp1047 cp37 posix-bc);
3147         my $str           = join( &#39;&#39;, map( chr($_), 0x20 .. 0x7E ) );
3148         return unless ($str);</code></pre>
3149
3150 <p>using <b>perltidy -kgb</b> gives:</p>
3151
3152 <pre><code>        print &quot;Entering test 2\n&quot;;
3153                                       &lt;----------this blank controlled by -kgbb
3154         use Test;
3155         use Encode qw(from_to encode decode
3156           encode_utf8 decode_utf8
3157           find_encoding is_utf8);
3158         use charnames qw(greek);
3159                                       &lt;---------this blank controlled by -kgbi
3160         my @encodings     = grep( /iso-?8859/, Encode::encodings() );
3161         my @character_set = ( &#39;0&#39; .. &#39;9&#39;, &#39;A&#39; .. &#39;Z&#39;, &#39;a&#39; .. &#39;z&#39; );
3162         my @source        = qw(ascii iso8859-1 cp1250);
3163         my @destiny       = qw(cp1047 cp37 posix-bc);
3164         my @ebcdic_sets   = qw(cp1047 cp37 posix-bc);
3165         my $str           = join( &#39;&#39;, map( chr($_), 0x20 .. 0x7E ) );
3166                                       &lt;----------this blank controlled by -kgba
3167         return unless ($str);</code></pre>
3168
3169 <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>
3170
3171 <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>
3172
3173 <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>
3174
3175 <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>
3176
3177 <pre><code>    s      min   max         number for group
3178     3      3     unlimited   3 or more
3179     1.1    1     1           1
3180     1..3   1     3           1 to 3
3181     1.0    1     0           (no match)</code></pre>
3182
3183 <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>
3184
3185 <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>
3186
3187 <pre><code>   n=0 =&gt; (delete) an existing blank line will be removed
3188    n=1 =&gt; (stable) no change to the input file is made  [DEFAULT]
3189    n=2 =&gt; (insert) a blank line is introduced if possible</code></pre>
3190
3191 <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>
3192
3193 <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>
3194
3195 <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>
3196
3197 <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>
3198
3199 <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>
3200
3201 <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>
3202
3203 <p>Here are a few notes about the functioning of this technique.</p>
3204
3205 <ul>
3206
3207 <li><p>These parameters are probably more useful as part of a major code reformatting operation rather than as a routine formatting operation.</p>
3208
3209 <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>
3210
3211 </li>
3212 <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>
3213
3214 <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>
3215
3216 <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>
3217
3218 </li>
3219 <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>
3220
3221 </li>
3222 <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>
3223
3224 </li>
3225 <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>
3226
3227 </li>
3228 </ul>
3229
3230 <h2 id="Styles">Styles</h2>
3231
3232 <p>A style refers to a convenient collection of existing parameters.</p>
3233
3234 <dl>
3235
3236 <dt id="gnu---gnu-style"><b>-gnu</b>, <b>--gnu-style</b></dt>
3237 <dd>
3238
3239 <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>
3240
3241 <pre><code>    -lp -bl -noll -pt=2 -bt=2 -sbt=2 -icp</code></pre>
3242
3243 <p>To use this style with <b>-xlp</b> instead of <b>-lp</b> use <b>-gnu -xlp</b>.</p>
3244
3245 </dd>
3246 <dt id="pbp---perl-best-practices"><b>-pbp</b>, <b>--perl-best-practices</b></dt>
3247 <dd>
3248
3249 <p><b>-pbp</b> is an abbreviation for the parameters in the book <b>Perl Best Practices</b> by Damian Conway:</p>
3250
3251 <pre><code>    -l=78 -i=4 -ci=4 -st -se -vt=2 -cti=0 -pt=1 -bt=1 -sbt=1 -bbt=1 -nsfs -nolq
3252     -wbb=&quot;% + - * / x != == &gt;= &lt;= =~ !~ &lt; &gt; | &amp; =
3253           **= += *= &amp;= &lt;&lt;= &amp;&amp;= -= /= |= &gt;&gt;= ||= //= .= %= ^= x=&quot;</code></pre>
3254
3255 <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>
3256
3257 <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 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>
3258
3259 <pre><code>    # perltidy -pbp
3260     $self-&gt;{_text} = (
3261          !$section        ? &#39;&#39;
3262         : $type eq &#39;item&#39; ? &quot;the $section entry&quot;
3263         :                   &quot;the section on $section&quot;
3264         )
3265         . (
3266         $page
3267         ? ( $section ? &#39; in &#39; : &#39;&#39; ) . &quot;the $page$page_ext manpage&quot;
3268         : &#39; elsewhere in this document&#39;
3269         );
3270
3271     # perltidy -pbp -ci=2
3272     $self-&gt;{_text} = (
3273          !$section        ? &#39;&#39;
3274         : $type eq &#39;item&#39; ? &quot;the $section entry&quot;
3275         :                   &quot;the section on $section&quot;
3276       )
3277       . (
3278         $page
3279         ? ( $section ? &#39; in &#39; : &#39;&#39; ) . &quot;the $page$page_ext manpage&quot;
3280         : &#39; elsewhere in this document&#39;
3281       );
3282
3283     # perltidy -pbp -xci
3284     $self-&gt;{_text} = (
3285          !$section        ? &#39;&#39;
3286         : $type eq &#39;item&#39; ? &quot;the $section entry&quot;
3287         :                   &quot;the section on $section&quot;
3288         )
3289         . ( $page
3290             ? ( $section ? &#39; in &#39; : &#39;&#39; ) . &quot;the $page$page_ext manpage&quot;
3291             : &#39; elsewhere in this document&#39;
3292         );</code></pre>
3293
3294 <p>The <b>-xci</b> flag was developed after the <b>-pbp</b> parameters were published so you need to include it separately.</p>
3295
3296 </dd>
3297 <dt id="One-line-blocks"><b>One-line blocks</b></dt>
3298 <dd>
3299
3300 <p>There are a few points to note regarding one-line blocks. A one-line block is something like this,</p>
3301
3302 <pre><code>    if ( -e $file ) { print &quot;&#39;$file&#39; exists\n&quot; }</code></pre>
3303
3304 <p>where the contents within the curly braces is short enough to fit on a single line.</p>
3305
3306 <p>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 one-line block style of the input file.</p>
3307
3308 <p>If an existing one-line block is longer than the maximum line length, however, it will be broken into multiple lines. When this happens, perltidy checks for and adds any optional terminating semicolon (unless the <b>-nasc</b> option is used) if the block is a code block.</p>
3309
3310 <p>The main exception is that perltidy will attempt to form new one-line blocks following the keywords <code>map</code>, <code>eval</code>, and <code>sort</code>, because these code blocks are often small and most clearly displayed in a single line.</p>
3311
3312 <p>One-line block rules can conflict with the cuddled-else option. When the cuddled-else option is used, perltidy retains existing one-line blocks, even if they do not obey cuddled-else formatting.</p>
3313
3314 <p>Occasionally, when one-line blocks get broken because they exceed the available line length, the formatting will violate the requested brace style. If this happens, reformatting the script a second time should correct the problem.</p>
3315
3316 <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>
3317
3318 <pre><code>     cat infile | perltidy -nanl | perltidy &gt;outfile</code></pre>
3319
3320 <p>When executed on this snippet</p>
3321
3322 <pre><code>    if ( $? == -1 ) {
3323         die &quot;failed to execute: $!\n&quot;;
3324     }
3325     if ( $? == -1 ) {
3326         print &quot;Had enough.\n&quot;;
3327         die &quot;failed to execute: $!\n&quot;;
3328     }</code></pre>
3329
3330 <p>the result is</p>
3331
3332 <pre><code>    if ( $? == -1 ) { die &quot;failed to execute: $!\n&quot;; }
3333     if ( $? == -1 ) {
3334         print &quot;Had enough.\n&quot;;
3335         die &quot;failed to execute: $!\n&quot;;
3336     }</code></pre>
3337
3338 <p>This shows that blocks with a single statement become one-line blocks.</p>
3339
3340 </dd>
3341 <dt id="olbs-n---one-line-block-semicolons-n"><b>-olbs=n</b>, <b>--one-line-block-semicolons=n</b></dt>
3342 <dd>
3343
3344 <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>
3345
3346 <pre><code>  n=0 remove terminal semicolons in one-line blocks having a single statement
3347   n=1 stable; keep input file placement of terminal semicolons [DEFAULT ]
3348   n=2 add terminal semicolons in all one-line blocks</code></pre>
3349
3350 <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>
3351
3352 </dd>
3353 <dt id="olbn-n---one-line-block-nesting-n"><b>-olbn=n</b>, <b>--one-line-block-nesting=n</b></dt>
3354 <dd>
3355
3356 <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>
3357
3358 <pre><code>         foreach (@list) { if ($_ eq $asked_for) { last } ++$found }</code></pre>
3359
3360 <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>
3361
3362 <pre><code>  n=0 break nested one-line blocks into multiple lines [DEFAULT]
3363   n=1 stable: keep existing nested-one line blocks intact</code></pre>
3364
3365 <p>For the above example, the default formatting (<b>-olbn=0</b>) is</p>
3366
3367 <pre><code>    foreach (@list) {
3368         if ( $_ eq $asked_for ) { last }
3369         ++$found;
3370     }</code></pre>
3371
3372 <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>
3373
3374 </dd>
3375 </dl>
3376
3377 <h2 id="Controlling-Vertical-Alignment">Controlling Vertical Alignment</h2>
3378
3379 <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>
3380
3381 <pre><code>        $data = $pkg-&gt;new(
3382             PeerAddr =&gt; join( &quot;.&quot;, @port[ 0 .. 3 ] ),
3383             PeerPort =&gt; $port[4] * 256 + $port[5],
3384             Proto    =&gt; &#39;tcp&#39;
3385         );</code></pre>
3386
3387 <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>
3388
3389 <pre><code>    %option_range = (
3390         &#39;format&#39;             =&gt; [ &#39;tidy&#39;, &#39;html&#39;, &#39;user&#39; ],
3391         &#39;output-line-ending&#39; =&gt; [ &#39;dos&#39;,  &#39;win&#39;,  &#39;mac&#39;, &#39;unix&#39; ],
3392         &#39;character-encoding&#39; =&gt; [ &#39;none&#39;, &#39;utf8&#39; ],
3393
3394         &#39;block-brace-tightness&#39;    =&gt; [ 0, 2 ],
3395         &#39;brace-tightness&#39;          =&gt; [ 0, 2 ],
3396         &#39;paren-tightness&#39;          =&gt; [ 0, 2 ],
3397         &#39;square-bracket-tightness&#39; =&gt; [ 0, 2 ],
3398     );</code></pre>
3399
3400 <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>
3401
3402 <p>For example,</p>
3403
3404 <pre><code>        # perltidy -nwls=&#39;=&gt;&#39;
3405         $data = $pkg-&gt;new(
3406             PeerAddr=&gt; join( &quot;.&quot;, @port[ 0 .. 3 ] ),
3407             PeerPort=&gt; $port[4] * 256 + $port[5],
3408             Proto=&gt; &#39;tcp&#39;
3409         );</code></pre>
3410
3411 <dl>
3412
3413 <dt id="Completely-turning-off-vertical-alignment-with--novalign"><b>Completely turning off vertical alignment with -novalign</b></dt>
3414 <dd>
3415
3416 <p>The default is to use vertical alignment, but vertical alignment can be completely turned of with the <b>-novalign</b> flag.</p>
3417
3418 <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>
3419
3420 <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>
3421
3422 </dd>
3423 <dt id="Controlling-code-alignment-with---valign-code-or--vc"><b>Controlling code alignment with --valign-code or -vc</b></dt>
3424 <dd>
3425
3426 <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>
3427
3428 </dd>
3429 <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>
3430 <dd>
3431
3432 <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>
3433
3434 </dd>
3435 <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>
3436 <dd>
3437
3438 <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>
3439
3440 </dd>
3441 <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>
3442 <dd>
3443
3444 <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>
3445
3446 <pre><code>  = **= += *= &amp;= &lt;&lt;= &amp;&amp;= -= /= |= &gt;&gt;= ||= //= .= %= ^= x=
3447   { ( ? : , ; =&gt; &amp;&amp; || ~~ !~~ =~ !~ // &lt;=&gt; -&gt; q
3448   if unless and or err for foreach while until</code></pre>
3449
3450 <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>
3451
3452 <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>
3453
3454 <pre><code>  --valign-exclusion-list=&#39;= if&#39;</code></pre>
3455
3456 <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>
3457
3458 <pre><code>  --valign-inclusion-list=&#39;, =&gt;&#39;
3459   --valign-exclusion-list=&#39;*&#39;     ( this is optional and may be omitted )</code></pre>
3460
3461 <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>
3462
3463 <p>The default values of these parameters enable all alignments and are equivalent to</p>
3464
3465 <pre><code>  --valign-exclusion-list=&#39; &#39;
3466   --valign-inclusion-list=&#39;*&#39;</code></pre>
3467
3468 <p>To illustrate, consider the following snippet with default formatting</p>
3469
3470 <pre><code>    # perltidy
3471     $co_description = ($color) ? &#39;bold cyan&#39;  : &#39;&#39;;           # description
3472     $co_prompt      = ($color) ? &#39;bold green&#39; : &#39;&#39;;           # prompt
3473     $co_unused      = ($color) ? &#39;on_green&#39;   : &#39;reverse&#39;;    # unused</code></pre>
3474
3475 <p>To exclude all alignments except the equals (i.e., include only equals) we could use:</p>
3476
3477 <pre><code>    # perltidy -vil=&#39;=&#39;
3478     $co_description = ($color) ? &#39;bold cyan&#39; : &#39;&#39;;          # description
3479     $co_prompt      = ($color) ? &#39;bold green&#39; : &#39;&#39;;         # prompt
3480     $co_unused      = ($color) ? &#39;on_green&#39; : &#39;reverse&#39;;    # unused</code></pre>
3481
3482 <p>To exclude only the equals we could use:</p>
3483
3484 <pre><code>    # perltidy -vxl=&#39;=&#39;
3485     $co_description = ($color) ? &#39;bold cyan&#39; : &#39;&#39;;     # description
3486     $co_prompt = ($color) ? &#39;bold green&#39; : &#39;&#39;;         # prompt
3487     $co_unused = ($color) ? &#39;on_green&#39; : &#39;reverse&#39;;    # unused</code></pre>
3488
3489 <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>
3490
3491 <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>
3492
3493 </dd>
3494 </dl>
3495
3496 <h2 id="Other-Controls">Other Controls</h2>
3497
3498 <dl>
3499
3500 <dt id="Deleting-selected-text"><b>Deleting selected text</b></dt>
3501 <dd>
3502
3503 <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>
3504
3505 <p>The command <b>-dp</b> or <b>--delete-pod</b> will remove all pod documentation (but not comments).</p>
3506
3507 <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>
3508
3509 <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>
3510
3511 <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>
3512
3513 </dd>
3514 <dt id="Writing-selected-text-to-a-file"><b>Writing selected text to a file</b></dt>
3515 <dd>
3516
3517 <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>
3518
3519 <p>The command <b>-tac</b> or <b>--tee-all-comments</b> will write all comments <b>and</b> all pod documentation.</p>
3520
3521 <p>The command <b>-tp</b> or <b>--tee-pod</b> will write all pod documentation (but not comments).</p>
3522
3523 <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>
3524
3525 <p>The negatives of these commands also work, and are the defaults.</p>
3526
3527 </dd>
3528 <dt id="Using-a-.perltidyrc-command-file"><b>Using a <i>.perltidyrc</i> command file</b></dt>
3529 <dd>
3530
3531 <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>
3532
3533 <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>
3534
3535 <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>
3536
3537 <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>
3538
3539 <p>http://www.netmanage.com/000/20021101_005_tcm21-6336.pdf</p>
3540
3541 <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>
3542
3543 <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>
3544
3545 <p>Here is an example of a <i>.perltidyrc</i> file:</p>
3546
3547 <pre><code>  # This is a simple of a .perltidyrc configuration file
3548   # This implements a highly spaced style
3549   -se    # errors to standard error output
3550   -w     # show all warnings
3551   -bl    # braces on new lines
3552   -pt=0  # parens not tight at all
3553   -bt=0  # braces not tight
3554   -sbt=0 # square brackets not tight</code></pre>
3555
3556 <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>
3557
3558 <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>
3559
3560 <pre><code> -h -v -ddf -dln -dop -dsn -dtt -dwls -dwrs -ss</code></pre>
3561
3562 <p>There are several options may be helpful in debugging a <i>.perltidyrc</i> file:</p>
3563
3564 <ul>
3565
3566 <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>
3567
3568 <pre><code>  perltidy -dpro</code></pre>
3569
3570 </li>
3571 <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>
3572
3573 </li>
3574 <li><p>The parameters in the <i>.perltidyrc</i> file can be switched off with the <b>-npro</b> option.</p>
3575
3576 </li>
3577 <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>
3578
3579 </li>
3580 </ul>
3581
3582 </dd>
3583 <dt id="Creating-a-new-abbreviation"><b>Creating a new abbreviation</b></dt>
3584 <dd>
3585
3586 <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>
3587
3588 <pre><code>        newword {
3589         -opt1
3590         -opt2
3591         }</code></pre>
3592
3593 <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>
3594
3595 <p>For a specific example, the following line</p>
3596
3597 <pre><code>        oneliner { --maximum-line-length=0 --noadd-newlines --noadd-terminal-newline}</code></pre>
3598
3599 <p>or equivalently with abbreviations</p>
3600
3601 <pre><code>        oneliner { -l=0 -nanl -natnl }</code></pre>
3602
3603 <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>
3604
3605 <pre><code>        perltidy --oneliner ...</code></pre>
3606
3607 <p>(Either <code>-oneliner</code> or <code>--oneliner</code> may be used).</p>
3608
3609 </dd>
3610 <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>
3611 <dd>
3612
3613 <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>
3614
3615 <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>
3616
3617 </dd>
3618 <dt id="Making-a-file-unreadable"><b>Making a file unreadable</b></dt>
3619 <dd>
3620
3621 <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>
3622
3623 <pre><code>  perltidy --mangle myfile.pl -st | perltidy -o myfile.pl.new</code></pre>
3624
3625 <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>
3626
3627 <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>
3628
3629 <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>
3630
3631 </dd>
3632 <dt id="Debugging"><b>Debugging</b></dt>
3633 <dd>
3634
3635 <p>The following flags are available for debugging:</p>
3636
3637 <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>
3638
3639 <p><b>--dump-defaults</b> or <b>-ddf</b> will write the default option set to standard output and quit</p>
3640
3641 <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>
3642
3643 <p><b>--dump-options</b> or <b>-dop</b> will write current option set to standard output and quit.</p>
3644
3645 <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>
3646
3647 <p><b>--dump-short-names</b> or <b>-dsn</b> will write all command line short names to standard output and quit.</p>
3648
3649 <p><b>--dump-token-types</b> or <b>-dtt</b> will write a list of all token types to standard output and quit.</p>
3650
3651 <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>
3652
3653 <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>
3654
3655 <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>
3656
3657 <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>
3658
3659 <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>
3660
3661 <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>
3662
3663 <pre><code>  perltidy -maxfs=20</code></pre>
3664
3665 <p>This only applies to files specified by filename on the command line.</p>
3666
3667 <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>
3668
3669 <p>For example, the following script has level error of 3 and will be output verbatim</p>
3670
3671 <pre><code>    Input and default output:
3672     {{{
3673
3674
3675     perltidy -maxle=100
3676     {
3677         {
3678             {</code></pre>
3679
3680 <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>
3681
3682 <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>
3683
3684 <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>
3685
3686 </dd>
3687 <dt id="Working-with-MakeMaker-AutoLoader-and-SelfLoader"><b>Working with MakeMaker, AutoLoader and SelfLoader</b></dt>
3688 <dd>
3689
3690 <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>
3691
3692 <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>
3693
3694 <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>
3695
3696 </dd>
3697 <dt id="Working-around-problems-with-older-version-of-Perl"><b>Working around problems with older version of Perl</b></dt>
3698 <dd>
3699
3700 <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>
3701
3702 <p>There is no way to override these rules.</p>
3703
3704 </dd>
3705 </dl>
3706
3707 <h1 id="HTML-OPTIONS">HTML OPTIONS</h1>
3708
3709 <dl>
3710
3711 <dt id="The--html-master-switch">The <b>-html</b> master switch</dt>
3712 <dd>
3713
3714 <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>
3715
3716 <pre><code>        perltidy -html somefile.pl</code></pre>
3717
3718 <p>will produce a syntax-colored html file named <i>somefile.pl.html</i> which may be viewed with a browser.</p>
3719
3720 <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>
3721
3722 </dd>
3723 <dt id="The--pre-flag-for-code-snippets">The <b>-pre</b> flag for code snippets</dt>
3724 <dd>
3725
3726 <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>
3727
3728 </dd>
3729 <dt id="The--nnn-flag-for-line-numbering">The <b>-nnn</b> flag for line numbering</dt>
3730 <dd>
3731
3732 <p>When the <b>-nnn</b> flag is given, the output lines will be numbered.</p>
3733
3734 </dd>
3735 <dt id="The--toc-or---html-table-of-contents-flag">The <b>-toc</b>, or <b>--html-table-of-contents</b> flag</dt>
3736 <dd>
3737
3738 <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>
3739
3740 </dd>
3741 <dt id="The--pod-or---pod2html-flag">The <b>-pod</b>, or <b>--pod2html</b> flag</dt>
3742 <dd>
3743
3744 <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>
3745
3746 <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>
3747
3748 <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>
3749
3750 <pre><code>   --[no]podheader --[no]podindex --[no]podrecurse --[no]podquiet
3751    --[no]podverbose --podflush</code></pre>
3752
3753 <p>The flags which are unchanged from their use in pod2html are:</p>
3754
3755 <pre><code>   --backlink=s --cachedir=s --htmlroot=s --libpods=s --title=s
3756    --podpath=s --podroot=s</code></pre>
3757
3758 <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>
3759
3760 <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>
3761
3762 </dd>
3763 <dt id="The--frm-or---frames-flag">The <b>-frm</b>, or <b>--frames</b> flag</dt>
3764 <dd>
3765
3766 <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>
3767
3768 <pre><code> MyModule.pm.html      - the frame
3769  MyModule.pm.toc.html  - the table of contents
3770  MyModule.pm.src.html  - the formatted source code</code></pre>
3771
3772 <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>
3773
3774 </dd>
3775 <dt id="The--text-s-or---html-toc-extension-flag">The <b>-text=s</b>, or <b>--html-toc-extension</b> flag</dt>
3776 <dd>
3777
3778 <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>
3779
3780 </dd>
3781 <dt id="The--sext-s-or---html-src-extension-flag">The <b>-sext=s</b>, or <b>--html-src-extension</b> flag</dt>
3782 <dd>
3783
3784 <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>
3785
3786 </dd>
3787 <dt id="The--hent-or---html-entities-flag">The <b>-hent</b>, or <b>--html-entities</b> flag</dt>
3788 <dd>
3789
3790 <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>
3791
3792 </dd>
3793 <dt id="Style-Sheets"><b>Style Sheets</b></dt>
3794 <dd>
3795
3796 <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>
3797
3798 <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>
3799
3800 <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>
3801
3802 <pre><code>  perltidy -html -ss &gt;mystyle.css</code></pre>
3803
3804 <p>will write a style sheet with the default properties to file <i>mystyle.css</i>.</p>
3805
3806 <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>
3807
3808 </dd>
3809 <dt id="Controlling-HTML-properties"><b>Controlling HTML properties</b></dt>
3810 <dd>
3811
3812 <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>
3813
3814 <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>
3815
3816 <pre><code>      Token Type             xxxxxx           x
3817       ----------             --------         --
3818       comment                comment          c
3819       number                 numeric          n
3820       identifier             identifier       i
3821       bareword, function     bareword         w
3822       keyword                keyword          k
3823       quite, pattern         quote            q
3824       here doc text          here-doc-text    h
3825       here doc target        here-doc-target  hh
3826       punctuation            punctuation      pu
3827       parentheses            paren            p
3828       structural braces      structure        s
3829       semicolon              semicolon        sc
3830       colon                  colon            co
3831       comma                  comma            cm
3832       label                  label            j
3833       sub definition name    subroutine       m
3834       pod text               pod-text         pd</code></pre>
3835
3836 <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>
3837
3838 <p>To illustrate, the following command will produce an html file <i>somefile.pl.html</i> with &quot;aqua&quot; keywords:</p>
3839
3840 <pre><code>        perltidy -html -hck=00ffff somefile.pl</code></pre>
3841
3842 <p>and this should be equivalent for most browsers:</p>
3843
3844 <pre><code>        perltidy -html -hck=aqua somefile.pl</code></pre>
3845
3846 <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>
3847
3848 <pre><code>        black   =&gt; 000000,
3849         silver  =&gt; c0c0c0,
3850         gray    =&gt; 808080,
3851         white   =&gt; ffffff,
3852         maroon  =&gt; 800000,
3853         red     =&gt; ff0000,
3854         purple  =&gt; 800080,
3855         fuchsia =&gt; ff00ff,
3856         green   =&gt; 008000,
3857         lime    =&gt; 00ff00,
3858         olive   =&gt; 808000,
3859         yellow  =&gt; ffff00
3860         navy    =&gt; 000080,
3861         blue    =&gt; 0000ff,
3862         teal    =&gt; 008080,
3863         aqua    =&gt; 00ffff,</code></pre>
3864
3865 <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>
3866
3867 <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>
3868
3869 <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>
3870
3871 <p>For example, to use bold braces and lime color, non-bold, italics keywords the following command would be used:</p>
3872
3873 <pre><code>        perltidy -html -hbs -hck=00FF00 -nhbk -hik somefile.pl</code></pre>
3874
3875 <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>
3876
3877 <p>Here are some notes and hints:</p>
3878
3879 <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>
3880
3881 <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>
3882
3883 <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>
3884
3885 </dd>
3886 </dl>
3887
3888 <h1 id="SOME-COMMON-INPUT-CONVENTIONS">SOME COMMON INPUT CONVENTIONS</h1>
3889
3890 <h2 id="Specifying-Block-Types">Specifying Block Types</h2>
3891
3892 <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>
3893
3894 <p>The keyword <b>sub</b> indicates a named sub. For anonymous subs, use the special keyword <b>asub</b>.</p>
3895
3896 <p>For example, the following parameter specifies <code>sub</code>, labels, <code>BEGIN</code>, and <code>END</code> blocks:</p>
3897
3898 <pre><code>   -cscl=&quot;sub : BEGIN END&quot;</code></pre>
3899
3900 <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>
3901
3902 <pre><code>   -bbvtl=&#39;*&#39;</code></pre>
3903
3904 <h2 id="Specifying-File-Extensions">Specifying File Extensions</h2>
3905
3906 <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>
3907
3908 <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>
3909
3910 <h1 id="SWITCHES-WHICH-MAY-BE-NEGATED">SWITCHES WHICH MAY BE NEGATED</h1>
3911
3912 <p>The following list shows all short parameter names which allow a prefix &#39;n&#39; to produce the negated form:</p>
3913
3914 <pre><code> D      anl    asbl   asc    ast    asu    atnl   aws    b      baa
3915  baao   bar    bbao   bbb    bbc    bbs    bl     bli    boa    boc
3916  bok    bol    bom    bos    bot    cblx   ce     conv   cs     csc
3917  cscb   cscw   dac    dbc    dcbl   dcsc   ddf    dln    dnl    dop
3918  dp     dpro   dsc    dsm    dsn    dtt    dwls   dwrs   dws    eos
3919  f      fll    fpva   frm    fs     fso    gcs    hbc    hbcm   hbco
3920  hbh    hbhh   hbi    hbj    hbk    hbm    hbn    hbp    hbpd   hbpu
3921  hbq    hbs    hbsc   hbv    hbw    hent   hic    hicm   hico   hih
3922  hihh   hii    hij    hik    him    hin    hip    hipd   hipu   hiq
3923  his    hisc   hiv    hiw    hsc    html   ibc    icb    icp    iob
3924  isbc   iscl   kgb    kgbd   kgbi   kis    lal    log    lop    lp
3925  lsl    mem    nib    ohbr   okw    ola    olc    oll    olq    opr
3926  opt    osbc   osbr   otr    ple    pod    pvl    q      sac    sbc
3927  sbl    scbb   schb   scp    scsb   sct    se     sfp    sfs    skp
3928  sob    sobb   sohb   sop    sosb   sot    ssc    st     sts    t
3929  tac    tbc    toc    tp     tqw    trp    ts     tsc    tso    vbc
3930  vc     vmll   vsc    w      wn     x      xci    xlp    xs</code></pre>
3931
3932 <p>Equivalently, the prefix &#39;no&#39; or &#39;no-&#39; on the corresponding long names may be used.</p>
3933
3934 <h1 id="LIMITATIONS">LIMITATIONS</h1>
3935
3936 <dl>
3937
3938 <dt id="Parsing-Limitations"><b>Parsing Limitations</b></dt>
3939 <dd>
3940
3941 <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>
3942
3943 <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>
3944
3945 <p>If you encounter a bug, please report it.</p>
3946
3947 </dd>
3948 <dt id="What-perltidy-does-not-parse-and-format"><b>What perltidy does not parse and format</b></dt>
3949 <dd>
3950
3951 <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>
3952
3953 </dd>
3954 </dl>
3955
3956 <h1 id="FILES">FILES</h1>
3957
3958 <dl>
3959
3960 <dt id="Temporary-files"><b>Temporary files</b></dt>
3961 <dd>
3962
3963 <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>
3964
3965 </dd>
3966 <dt id="Special-files-when-standard-input-is-used"><b>Special files when standard input is used</b></dt>
3967 <dd>
3968
3969 <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>
3970
3971 </dd>
3972 <dt id="Files-overwritten"><b>Files overwritten</b></dt>
3973 <dd>
3974
3975 <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>
3976
3977 </dd>
3978 <dt id="Files-extensions-limitations"><b>Files extensions limitations</b></dt>
3979 <dd>
3980
3981 <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>
3982
3983 </dd>
3984 </dl>
3985
3986 <h1 id="ERROR-HANDLING">ERROR HANDLING</h1>
3987
3988 <p>An exit value of 0, 1, or 2 is returned by perltidy to indicate the status of the result.</p>
3989
3990 <p>A exit value of 0 indicates that perltidy ran to completion with no error messages.</p>
3991
3992 <p>A non-zero exit value indicates some kind of problem was detected.</p>
3993
3994 <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>
3995
3996 <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>
3997
3998 <h1 id="SEE-ALSO">SEE ALSO</h1>
3999
4000 <p>perlstyle(1), Perl::Tidy(3)</p>
4001
4002 <h1 id="INSTALLATION">INSTALLATION</h1>
4003
4004 <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>
4005
4006 <h1 id="VERSION">VERSION</h1>
4007
4008 <p>This man page documents perltidy version 20220613</p>
4009
4010 <h1 id="BUG-REPORTS">BUG REPORTS</h1>
4011
4012 <p>The source code repository is at <a href="https://github.com/perltidy/perltidy">https://github.com/perltidy/perltidy</a>.</p>
4013
4014 <p>To report a new bug or problem, use the &quot;issues&quot; link on this page.</p>
4015
4016 <h1 id="COPYRIGHT">COPYRIGHT</h1>
4017
4018 <p>Copyright (c) 2000-2022 by Steve Hancock</p>
4019
4020 <h1 id="LICENSE">LICENSE</h1>
4021
4022 <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>
4023
4024 <p>Please refer to the file &quot;COPYING&quot; for details.</p>
4025
4026 <h1 id="DISCLAIMER">DISCLAIMER</h1>
4027
4028 <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>
4029
4030 <p>See the &quot;GNU General Public License&quot; for more details.</p>
4031
4032
4033 </body>
4034
4035 </html>
4036
4037