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