annotate indenters/uigui_perltidy.ini @ 778:a0f609a86954

Updated the perltidy config file to suit for version 1.74 of perltidy. git-svn-id: svn://svn.code.sf.net/p/universalindent/code/trunk@1055 59b1889a-e5ac-428c-b0c7-476e01d41282
author thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
date Tue, 27 Dec 2011 13:44:54 +0000
parents 6dda59f4cc5a
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
778
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
1 [header]
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
2 categories=Styles|Basic Options|Code Indentation Control|Whitespace Control|Comment Controls|Skip Selected Codesections|Line Break Control|Controlling List Formatting|Retaining or Ignoring Existing Line Breaks|Blank Line Control|Other Controls
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
3 cfgFileParameterEnding=cr
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
4 configFilename=perltidy.cfg
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
5 fileTypes=*.pl|*.pm
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
6 indenterFileName=perltidy
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
7 indenterName=Perltidy (Perl)
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
8 inputFileName=indentinput
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
9 inputFileParameter=
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
10 manual=http://perltidy.sourceforge.net/perltidy.html
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
11 outputFileName=indentoutput
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
12 outputFileParameter="-o="
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
13 parameterOrder=pio
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
14 showHelpParameter=-h
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
15 stringparaminquotes=false
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
16 useCfgFileParameter="-pro="
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
17 version=1.74 2010/12/17
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
18
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
19 [Iterations]
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
20 CallName="--iterations="
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
21 Category=1
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
22 Description="<html>This flag causes perltidy to do n complete iterations. For most purposes the default of n=1 should be satisfactory. However n=2 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. The run time will be approximately proportional to n, and it should seldom be necessary to use a value greater than n=2.</html>"
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
23 EditorType=numeric
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
24 Enabled=false
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
25 MaxVal=10
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
26 MinVal=1
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
27 ValueDefault=1
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
28
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
29 [Add newlines]
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
30 Category=6
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
31 Description="<html><dd><p>By default, perltidy will add line breaks when necessary to create continuations of long lines and to improve the script appearance. Use <strong>-nanl</strong> or <strong>--noadd-newlines</strong> to prevent any new line breaks.</p></dd><dd><p>This flag does not prevent perltidy from eliminating existing line breaks; see <strong>--freeze-newlines</strong> to completely prevent changes to line break points.</p></dd></html>"
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
32 EditorType=boolean
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
33 TrueFalse=-anl|-nanl
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
34 ValueDefault=0
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
35
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
36 [Add semicolons]
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
37 Category=3
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
38 Description="<html><dd><p>Setting <strong>-asc</strong> 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 <strong>-nasc</strong> or <strong>--noadd-semicolons</strong>.</p></dd></html>"
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
39 EditorType=boolean
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
40 TrueFalse=--add-semicolons|
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
41 ValueDefault=0
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
42
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
43 [Add whitespace]
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
44 Category=3
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
45 Description="<html><dd><p>Setting this option allows perltidy to add certain whitespace improve code readability. This is the default. If you do not want any whitespace added, but are willing to have some whitespace deleted, use <strong>-naws</strong>. (Use <strong>-fws</strong> to leave whitespace completely unchanged).</p></dd></html>"
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
46 EditorType=boolean
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
47 TrueFalse=--add-whitespace|
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
48 ValueDefault=0
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
49
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
50 [Block brace tightness]
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
51 CallName="--block-brace-tightness="
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
52 Category=3
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
53 Description="<html><p>And finally, curly braces which contain blocks of code are controlled by the parameter <strong>-bbt=n</strong> or <strong>--block-brace-tightness=n</strong> as illustrated in the example below.</p></dd><dd><pre>\n %bf = map { $_ =&gt; -M $_ } grep { /deb$/ } dirents '.'; # -bbt=0 (default)\n %bf = map { $_ =&gt; -M $_ } grep {/deb$/} dirents '.'; # -bbt=1\n %bf = map {$_ =&gt; -M $_} grep {/deb$/} dirents '.'; # -bbt=2</pre></dd></html>"
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
54 EditorType=numeric
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
55 Enabled=false
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
56 MaxVal=2
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
57 MinVal=0
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
58 ValueDefault=1
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
59
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
60 [Block brace vertical tightness]
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
61 CallName="--block-brace-vertical-tightness="
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
62 Category=6
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
63 Description="<html><dd><p>The <strong>-bbvt=n</strong> flag is just like the <strong>-vt=n</strong> flag but applies to opening code block braces.</p></dd><dd><pre>\n -bbvt=0 break after opening block brace (default). \n -bbvt=1 do not break unless this would produce more than one \n step in indentation in a line.\n -bbvt=2 do not break after opening block brace.</pre></dd><dd><p>It is necessary to also use either <strong>-bl</strong> or <strong>-bli</strong> 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></dd><dd><pre>\n # perltidy -bli -bbvt=0\n if ( open( FILE, &quot;&lt; $File&quot; ) )\n {\n while ( $File = &lt;FILE&gt; )\n {\n $In .= $File;\n $count++;\n }\n close(FILE);\n }</pre></dd><dd><pre>\n # perltidy -bli -bbvt=1\n if ( open( FILE, &quot;&lt; $File&quot; ) )\n { while ( $File = &lt;FILE&gt; )\n { $In .= $File;\n $count++;\n }\n close(FILE);\n }</pre></dd><dd><p>By default this applies to blocks associated with keywords <strong>if</strong>, <strong>elsif</strong>, <strong>else</strong>, <strong>unless</strong>, <strong>for</strong>, <strong>foreach</strong>, <strong>sub</strong>, <strong>while</strong>, <strong>until</strong>, and also with a preceding label. This can be changed with the parameter <strong>-bbvtl=string</strong>, or <strong>--block-brace-vertical-tightness-list=string</strong>, where <strong>string</strong> is a space-separated list of block types. For more information on the possible values of this string, see <a href=#specifying_block_types>Specifying Block Types</a></p></dd><dd><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='if elsif else'</code>.</p></dd><dd><p>There is no vertical tightness control for closing block braces; with the exception of one-line blocks, they will normally remain on a separate line.</p></dd></html>"
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
64 EditorType=numeric
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
65 Enabled=false
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
66 MaxVal=2
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
67 MinVal=0
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
68 ValueDefault=0
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
69
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
70 [Brace left and indent]
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
71 Category=6
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
72 Description="<html><dd><p>The flag <strong>-bli</strong> is the same as <strong>-bl</strong> but in addition it causes one unit of continuation indentation ( see <strong>-ci</strong> ) to be placed before an opening and closing block braces.</p></dd><dd><p>For example,</p></dd><dd><pre>\n if ( $input_file eq '-' ) # -bli\n {\n important_function();\n }</pre></dd><dd><p>By default, this extra indentation occurs for blocks of type:<strong>if</strong>, <strong>elsif</strong>, <strong>else</strong>, <strong>unless</strong>, <strong>for</strong>, <strong>foreach</strong>, <strong>sub</strong>, <strong>while</strong>, <strong>until</strong>, and also with a preceding label. The next item shows how to change this.</p></dd></html>"
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
73 EditorType=boolean
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
74 TrueFalse=-bli|
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
75 ValueDefault=0
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
76
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
77 [Brace left and indent list]
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
78 CallName="--brace-left-and-indent-list="
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
79 Category=6
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
80 Description="<html><dd><p>Use this parameter to change the types of block braces for which the <strong>-bli</strong> flag applies; see <a href=#specifying_block_types>Specifying Block Types</a>. For example, <strong>-blil='if elsif else'</strong> would apply it to only <code>if/elsif/else</code> blocks.</p></dd></html>"
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
81 EditorType=string
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
82 Enabled=false
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
83 ValueDefault=
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
84
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
85 [Brace tightness]
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
86 CallName="--brace-tightness="
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
87 Category=3
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
88 Description="<html><p>Curly braces which do not contain code blocks are controlled by the parameter <strong>-bt=n</strong> or <strong>--brace-tightness=n</strong>.</p></dd><dd><pre>\n $obj-&gt;{ $parsed_sql-&gt;{ 'table' }[0] }; # -bt=0\n $obj-&gt;{ $parsed_sql-&gt;{'table'}[0] }; # -bt=1 (default)\n $obj-&gt;{$parsed_sql-&gt;{'table'}[0]}; # -bt=2</pre></dd></html>"
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
89 EditorType=numeric
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
90 Enabled=false
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
91 MaxVal=2
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
92 MinVal=0
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
93 ValueDefault=1
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
94
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
95 [Brace vertical tightness]
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
96 CallName="--brace-vertical-tightness="
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
97 Category=6
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
98 Description="<html><p>The <strong>-vt=n</strong> and <strong>-vtc=n</strong> 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><p>In fact, the parameter <strong>-vt=n</strong> is actually just an abbreviation for <strong>-pvt=n -bvt=n sbvt=n</strong>, and likewise <strong>-vtc=n</strong> is an abbreviation for <strong>-pvtc=n -bvtc=n sbvtc=n</strong>.</p></html>"
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
99 EditorType=numeric
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
100 Enabled=false
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
101 MaxVal=2
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
102 MinVal=0
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
103 ValueDefault=0
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
104
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
105 [Brace vertical tightness closing]
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
106 CallName="--brace-vertical-tightness-closing="
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
107 Category=6
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
108 Description="<html><p>The <strong>-vt=n</strong> and <strong>-vtc=n</strong> 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><p>In fact, the parameter <strong>-vt=n</strong> is actually just an abbreviation for <strong>-pvt=n -bvt=n sbvt=n</strong>, and likewise <strong>-vtc=n</strong> is an abbreviation for <strong>-pvtc=n -bvtc=n sbvtc=n</strong>.</p></html>"
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
109 EditorType=numeric
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
110 Enabled=false
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
111 MaxVal=2
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
112 MinVal=0
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
113 ValueDefault=0
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
114
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
115 [Break after all operators]
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
116 Category=6
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
117 Description="<html><dd><p>The -baao sets the default to be to break after all of the following operators:</p></dd><dd><pre>\n % + - * / x != == &gt;= &lt;= =~ !~ &lt; &gt; | &amp; \n = **= += *= &amp;= &lt;&lt;= &amp;&amp;= -= /= |= &gt;&gt;= ||= //= .= %= ^= x=\n . : ? &amp;&amp; || and or err xor</pre></dd><dd><p>and the <strong>-bbao</strong> 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 <strong>-wba</strong> and <strong>-wbb</strong> flags. For example, to break before all operators except an <strong>=</strong> one could use --bbao -wba='=' rather than listing every single perl operator except <strong>=</strong> on a -wbb flag.</p></dd></html>"
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
118 EditorType=boolean
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
119 TrueFalse=-baao|
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
120 ValueDefault=0
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
121
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
122 [Break before all operators]
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
123 Category=6
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
124 Description="<html><dd><p>The -baao sets the default to be to break after all of the following operators:</p></dd><dd><pre>\n % + - * / x != == &gt;= &lt;= =~ !~ &lt; &gt; | &amp; \n = **= += *= &amp;= &lt;&lt;= &amp;&amp;= -= /= |= &gt;&gt;= ||= //= .= %= ^= x=\n . : ? &amp;&amp; || and or err xor</pre></dd><dd><p>and the <strong>-bbao</strong> 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 <strong>-wba</strong> and <strong>-wbb</strong> flags. For example, to break before all operators except an <strong>=</strong> one could use --bbao -wba='=' rather than listing every single perl operator except <strong>=</strong> on a -wbb flag.</p></dd></html>"
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
125 EditorType=boolean
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
126 TrueFalse=-bbao|
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
127 ValueDefault=0
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
128
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
129 [Check syntax]
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
130 Category=1
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
131 Description="<html>This flag causes perltidy to run <code>perl -c -T</code> to check syntax of input and output. (To change the flags passed to perl, see the next item, <strong>-pscf</strong>). The results are written to the <em>.LOG</em> file, which will be saved if an error is detected in the output script. The output script is not checked if the input script has a syntax error. Perltidy does its own checking, but this option employs perl to get a ``second opinion''.</p></dd><dd><p>If perl reports errors in the input file, they will not be reported in the error output unless the <strong>--warning-output</strong> flag is given.</p></dd><dd><p>The default is <strong>not</strong> to do this type of syntax checking (although perltidy will still do as much self-checking as possible). The reason is that it causes all code in BEGIN blocks to be executed, for all modules being used, and this opens the door to security issues and infinite loops when running perltidy.</html>"
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
132 EditorType=boolean
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
133 Enabled=false
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
134 TrueFalse=--check-syntax|
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
135 ValueDefault=0
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
136
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
137 [Closing Side Comment Else Flag]
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
138 CallName="--closing-side-comment-else-flag="
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
139 Category=4
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
140 Description="<html><dd><p>The default, <strong>n=0</strong>, places the text of the opening <code>if</code> statement after any terminal <code>else</code>.</p></dd><dd><p>If <strong>n=2</strong> 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></dd><dd><p>If <strong>n=1</strong> is used, the results will be the same as <strong>n=2</strong> whenever the resulting line length is less than the maximum allowed.</p></dd></html>"
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
141 EditorType=numeric
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
142 Enabled=false
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
143 MaxVal=1000
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
144 MinVal=0
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
145 ValueDefault=0
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
146
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
147 [Closing Side Comment Interval]
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
148 CallName="--closing-side-comment-interval="
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
149 Category=4
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
150 Description="<html><dd><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></dd><dd><pre>\n # perltidy -csci=2 -csc\n sub message {\n if ( !defined( $_[0] ) ) {\n print(&quot;Hello, World\n&quot;);\n } ## end if ( !defined( $_[0] ))\n else {\n print( $_[0], &quot;\n&quot; );\n } ## end else [ if ( !defined( $_[0] ))\n } ## end sub message</pre></dd><dd><p>Now the <code>if</code> and <code>else</code> blocks are commented. However, now this has become very cluttered.</p></dd></html>"
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
151 EditorType=numeric
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
152 Enabled=false
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
153 MaxVal=1000
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
154 MinVal=0
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
155 ValueDefault=6
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
156
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
157 [Closing Side Comment List]
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
158 CallName="--closing-side-comment-list="
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
159 Category=4
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
160 Description="<html><dd><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 <strong>-cscl</strong> command changes the default list to be any selected block types; see <a href=#specifying_block_types>Specifying Block Types</a>. For example, the following command requests that only <code>sub</code>'s, labels, <code>BEGIN</code>, and <code>END</code> blocks be affected by any <strong>-csc</strong> or <strong>-dcsc</strong> operation:</p></dd><dd><pre>\n -cscl=&quot;sub : BEGIN END&quot;</pre></dd></html>"
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
161 EditorType=string
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
162 Enabled=false
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
163 ValueDefault=
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
164
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
165 [Closing Side Comment Maximum Text]
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
166 CallName="--closing-side-comment-maximum-text="
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
167 Category=4
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
168 Description="<html><dd><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>.</p></dd></html>"
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
169 EditorType=numeric
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
170 Enabled=false
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
171 MaxVal=1000
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
172 MinVal=0
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
173 ValueDefault=20
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
174
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
175 [Closing Side Comments Balanced]
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
176 Category=4
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
177 Description="<html><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><pre>\n perltidy -csc -ncscb\n } ## end foreach my $foo (sort { $b cmp $a ...</pre><p>However this causes a problem with editors editors which cannot recognize comments or are not configured to do so because they cannot &quot;bounce&quot; around in the text correctly. The <strong>-cscb</strong> flag has been added to help them by appending appropriate balancing structure:</p><pre>\n perltidy -csc -cscb\n } ## end foreach my $foo (sort { $b cmp $a ... })</pre><p>The default is <strong>-cscb</strong>.</p></html>"
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
178 EditorType=boolean
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
179 TrueFalse=--closing-side-comments-balanced|-ncscb
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
180 ValueDefault=1
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
181
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
182 [Closing Side Comment Prefix]
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
183 CallName="--closing-side-comment-prefix="
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
184 Category=4
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
185 Description="<html><dd><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></dd></html>"
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
186 EditorType=string
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
187 Enabled=false
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
188 ValueDefault=## end
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
189
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
190 [Closing Side Comment Warnings]
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
191 Category=4
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
192 Description="<html><dd><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></dd><dd><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 <strong>-csc</strong>.</p></dd></html>"
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
193 EditorType=boolean
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
194 TrueFalse=--closing-side-comment-warnings|
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
195 ValueDefault=0
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
196
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
197 [Closing Side Comments]
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
198 Category=4
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
199 Choices=-csc|-dcsc
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
200 ChoicesReadable=Add Closing Side Comments|Delete Closing Side Comments
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
201 Description="<html><dd><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 <strong>-csc</strong> (or <strong>--closing-side-comments</strong>) adds or updates closing side comments. For example, here is a small code snippet</p></dd><dd><pre>\n sub message {\n if ( !defined( $_[0] ) ) {\n print(&quot;Hello, World\n&quot;);\n }\n else {\n print( $_[0], &quot;\n&quot; );\n }\n }</pre></dd><dd><p>And here is the result of processing with <code>perltidy -csc</code>:</p></dd><dd><pre>\n sub message {\n if ( !defined( $_[0] ) ) {\n print(&quot;Hello, World\n&quot;);\n }\n else {\n print( $_[0], &quot;\n&quot; );\n }\n } ## end sub message</pre></dd><dd><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 <strong>-csci</strong> command, described below.</p></dd><dd><p>The command <strong>-dcsc</strong> (or <strong>--delete-closing-side-comments</strong>) reverses this process and removes these comments.</p></dd><dd><p>Several commands are available to modify the behavior of these two basic commands, <strong>-csc</strong> and <strong>-dcsc</strong>:</p></dd></html>"
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
202 EditorType=multiple
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
203 Enabled=false
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
204 ValueDefault=0
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
205
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
206 [Closing token indentation]
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
207 CallName="--closing-token-indentation="
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
208 Category=2
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
209 Description="<html>The <strong>-cti=n</strong> 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></dd><dd><pre>\n -cti = 0 no extra indentation (default)\n -cti = 1 extra indentation such that the closing token\n aligns with its opening token.\n -cti = 2 one extra indentation level if the line looks like:\n ); or ]; or };\n -cti = 3 one extra indentation level always</pre></dd><dd><p>The flags <strong>-cti=1</strong> and <strong>-cti=2</strong> work well with the <strong>-lp</strong> flag (previous section).</p></dd><dd><pre>\n # perltidy -lp -cti=1\n @month_of_year = (\n 'Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun',\n 'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec'\n );</pre></dd><dd><pre>\n # perltidy -lp -cti=2\n @month_of_year = (\n 'Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun',\n 'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec'\n );</pre></dd><dd><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<strong>cti=1</strong> is constrained to be no more than one indentation level.</p></dd><dd><p>If desired, this control can be applied independently to each of theclosing container token types. In fact, <strong>-cti=n</strong> is merely anabbreviation for <strong>-cpi=n -csbi=n -cbi=n</strong>, where: <strong>-cpi</strong> or <strong>--closing-paren-indentation</strong> controls <strong>)</strong>'s,<strong>-csbi</strong> or <strong>--closing-square-bracket-indentation</strong> controls <strong>]</strong>'s, <strong>-cbi</strong> or <strong>--closing-brace-indentation</strong> controls non-block <strong>}</strong>'s.</html>"
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
210 EditorType=numeric
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
211 Enabled=false
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
212 MaxVal=1000
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
213 MinVal=0
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
214 ValueDefault=0
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
215
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
216 [Continuation indentation]
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
217 CallName="--continuation-indentation="
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
218 Category=2
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
219 Description="<html>Continuation indentation is extra indentation spaces applied whena long line is broken. The default is n=2, illustrated here:</p></dd><dd><pre> my $level = # -ci=2 ( $max_index_to_go &gt;= 0 ) ? $levels_to_go[0] : $last_output_level;</pre></dd><dd><p>The same example, with n=0, is a little harder to read:</p></dd><dd><pre> my $level = # -ci=0 ( $max_index_to_go &gt;= 0 ) ? $levels_to_go[0] : $last_output_level;</pre></dd><dd><p>The value given to <strong>-ci</strong> is also used by some commands when a small space is required. Examples are commands for outdenting labels, <strong>-ola</strong>, and control keywords, <strong>-okw</strong>.</p></dd><dd><p>When default values are not used, it is suggested that the value <strong>n</strong> given with <strong>-ci=n</strong> be no more than about one-half of the number of spaces assigned to a full indentation level on the <strong>-i=n</strong> command.</html>"
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
220 EditorType=numeric
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
221 Enabled=false
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
222 MaxVal=1000
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
223 MinVal=0
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
224 ValueDefault=2
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
225
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
226 [Cuddled else]
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
227 Category=6
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
228 Description="<html><dd><p>Enable the ``cuddled else'' 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 <strong>-nce</strong> or <strong>--nocuddled-else</strong>. Here is a comparison of the alternatives:</p></dd><dd><pre>\n if ($task) {\n yyy();\n } else { # -ce\n zzz();\n }</pre></dd><dd><pre>\n if ($task) {\n yyy();\n }\n else { # -nce (default)\n zzz();\n }</pre></dd></html>"
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
229 EditorType=boolean
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
230 TrueFalse=-ce|-nce
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
231 ValueDefault=0
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
232
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
233 [Delete old newlines]
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
234 Category=6
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
235 Description="<html><dd><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 <strong>-ndnl</strong> or <strong>--nodelete-old-newlines</strong> to force perltidy to retain all old line break points.</p></dd></html>"
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
236 EditorType=boolean
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
237 TrueFalse=-dnl|-ndnl
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
238 ValueDefault=0
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
239
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
240 [Delete old whitespace]
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
241 Category=3
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
242 Description="<html><dd><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 <strong>-ndws</strong> or <strong>--nodelete-old-whitespace</strong>.</p></dd></html>"
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
243 EditorType=boolean
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
244 TrueFalse=--delete-old-whitespace|
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
245 ValueDefault=0
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
246
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
247 [Delete semicolons]
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
248 Category=3
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
249 Description="<html><dd><p>Setting <strong>-dsm</strong> allows perltidy to delete extra semicolons which are simply empty statements. This is the default, and may be deactivated with <strong>-ndsm</strong> or <strong>--nodelete-semicolons</strong>. (Such semicolons are not deleted, however, if they would promote a side comment to a block comment).</p></dd></html>"
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
250 EditorType=boolean
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
251 TrueFalse=--delete-semicolons|
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
252 ValueDefault=0
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
253
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
254 [Entab leading whitespace]
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
255 CallName="--entab-leading-whitespace="
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
256 Category=1
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
257 Description="This flag causes each <strong>n</strong> initial space characters to be replaced by one tab character. Note that the integer <strong>n</strong> is completely independent of the integer specified for indentation parameter, <strong>-i=n</strong>.</html>"
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
258 EditorType=numeric
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
259 Enabled=false
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
260 MaxVal=1000
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
261 MinVal=0
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
262 ValueDefault=4
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
263
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
264 [Feeze newlines]
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
265 Category=6
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
266 Description="<html><dd><p>If you do not want any changes to the line breaks in your script, set <strong>-fnl</strong>, and they will remain fixed, and the rest of the commands in this section and sections <a href=#controlling_list_formatting>Controlling List Formatting</a>, <a href=#retaining_or_ignoring_existing_line_breaks>Retaining or Ignoring Existing Line Breaks</a>, and <a href=#blank_line_control>Blank Line Control</a> will be ignored. You may want to use <strong>-noll</strong> with this.</p></dd></html>"
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
267 EditorType=boolean
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
268 TrueFalse=-fnl|
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
269 ValueDefault=0
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
270
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
271 [Fixed position side comment]
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
272 CallName="--fixed-position-side-comment="
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
273 Category=4
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
274 Description="<html><dd><p>This parameter tells perltidy to line up side comments in column number <strong>n</strong> whenever possible. The default, n=0, is not do do this.</p></dd></html>"
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
275 EditorType=numeric
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
276 Enabled=false
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
277 MaxVal=1000
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
278 MinVal=0
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
279 ValueDefault=0
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
280
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
281 [Format skipping]
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
282 Category=5
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
283 Description="<html><p>Selected lines of code may be passed verbatim to the output without any formatting. This feature is enabled by default but can be disabled with the <strong>--noformat-skipping</strong> or <strong>-nfs</strong> flag. It should be used sparingly to avoid littering code with markers, but it might be helpful for working around occasional problems. For example it might be useful for keeping the indentation of old commented code unchanged, keeping indentation of long blocks of aligned comments unchanged, keeping certain list formatting unchanged, or working around a glitch in perltidy.</p><dl><dt><strong><a name=item__2dfs_2c__2d_2dformat_2dskipping><strong>-fs</strong>, <strong>--format-skipping</strong></a></strong><dd><p>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 default beginning marker is #&lt;&lt;&lt; and the default ending marker is #&gt;&gt;&gt; but they may be changed (see next items below). Additional text may appear on these special comment lines provided that it is separated from the marker by at least one space. For example</p></dd><dd><pre>\n #&lt;&lt;&lt; do not let perltidy touch this\n my @list = (1,\n 1, 1,\n 1, 2, 1,\n 1, 3, 3, 1,\n 1, 4, 6, 4, 1,);\n #&gt;&gt;&gt;</pre></dd><dd><p>The comment markers may be placed at any location that a block comment may appear. If they do not appear to be working, use the -log flag and examine the <em>.LOG</em> file. Use <strong>-nfs</strong> to disable this feature.</p></dd></html>"
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
284 EditorType=boolean
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
285 TrueFalse=-fs|-nfs
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
286 ValueDefault=1
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
287
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
288 [Format skipping begin]
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
289 CallName="--format-skipping-begin="
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
290 Category=5
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
291 Description="<html><dd><p>The <strong>-fsb=string</strong> parameter may be used to change the beginning marker for format skipping. The default is equivalent to -fsb='#&lt;&lt;&lt;'. 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 '', so you must also include backslashes for characters to be taken literally rather than as patterns.</p></dd><dd><p>Some examples show how example strings become patterns:</p></dd><dd><pre>\n -fsb='#' becomes /^#/ which matches #{{{ but not #{{{{\n -fsb='#' becomes /^#/ which matches #** but not #***\n -fsb='#{2,}' becomes /^#{2,}/ which matches #** and #*****</pre></dd></html>"
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
292 EditorType=string
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
293 Enabled=false
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
294 ValueDefault=#<<<
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
295
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
296 [Format skipping end]
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
297 CallName="--format-skipping-end="
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
298 Category=5
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
299 Description="<html><dd><p>The <strong>-fsb=string</strong> is the corresponding parameter used to change the ending marker for format skipping. The default is equivalent to -fse='#&lt;&lt;&lt;'.</p></dd></html>"
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
300 EditorType=string
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
301 Enabled=false
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
302 ValueDefault=#<<<
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
303
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
304 [Freeze whitespace]
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
305 Category=3
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
306 Description="<html>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.</html>"
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
307 EditorType=boolean
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
308 TrueFalse=--freeze-whitespace|
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
309 ValueDefault=0
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
310
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
311 [Gnu style]
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
312 Category=0
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
313 Description="<html><dd><p><strong>-gnu</strong> 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></dd><dd><pre>\n -lp -bl -noll -pt=2 -bt=2 -sbt=2 -icp</pre></dd></html>"
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
314 EditorType=boolean
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
315 Enabled=false
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
316 TrueFalse=--gnu-style|
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
317 ValueDefault=0
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
318
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
319 [Hanging side comments]
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
320 Category=4
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
321 Description="<html><dd><p>By default, perltidy tries to identify and align ``hanging side comments'', which are something like this:</p></dd><dd><pre>\n my $IGNORE = 0; # This is a side comment\n # This is a hanging side comment\n # And so is this</pre></dd><dd><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 <strong>-nhsc</strong> or <strong>--nohanging-side-comments</strong>. If block comments are preceded by a blank line, or have no leading whitespace, they will not be mistaken as hanging side comments.</p></dd></html>"
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
322 EditorType=boolean
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
323 TrueFalse=-hsc|-nhsc
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
324 ValueDefault=0
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
325
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
326 [Indent block comments]
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
327 Category=4
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
328 Description="<html><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 <strong>-nibc</strong> to keep block comments left-justified. Here is an example:</p></dd><dd><pre>\n # this comment is indented (-ibc, default)\n if ($task) { yyy(); }</pre></dd><dd><p>The alternative is <strong>-nibc</strong>:</p></dd><dd><pre>\n # this comment is not indented (-nibc)\n if ($task) { yyy(); }</pre></dd><dd><p>See also the next item, <strong>-isbc</strong>, as well as <strong>-sbc</strong>, for other ways to have some indented and some outdented block comments.</p></dd></html>"
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
329 EditorType=boolean
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
330 TrueFalse=-ibc|-nibc
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
331 ValueDefault=1
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
332
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
333 [Indent closing brace]
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
334 Category=2
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
335 Description="<html>The <strong>-icb</strong> option gives one extra level of indentation to a brace which terminates a code block . For example,</p></dd><dd><pre>\n if ($task) {\n yyy();\n } # -icb\n else {\n zzz();\n }</pre></dd><dd><p>The default is not to do this, indicated by <strong>-nicb</strong>.</html>"
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
336 EditorType=boolean
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
337 TrueFalse=--indent-closing-brace|
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
338 ValueDefault=0
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
339
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
340 [Indent closing paren]
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
341 Category=2
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
342 Description="<html>The <strong>-icp</strong> flag is equivalent to<strong>-cti=2</strong>, described in the previous section. The <strong>-nicp</strong> flag is equivalent <strong>-cti=0</strong>. They are included for backwards compatability.</html>"
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
343 EditorType=boolean
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
344 TrueFalse=--indent-closing-paren|
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
345 ValueDefault=0
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
346
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
347 [Indent columns]
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
348 CallName="--indent-columns="
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
349 Category=1
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
350 Description="<html>Use n columns per indentation level (default n=4).</html>"
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
351 EditorType=numeric
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
352 Enabled=false
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
353 MaxVal=1000
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
354 MinVal=0
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
355 ValueDefault=4
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
356
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
357 [Indent only]
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
358 Category=1
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
359 Description="<html>This flag is used to deactivate all formatting and line break changes. When it is in effect, the only change to the script will be indentation. 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></dd><dd><p>Setting this flag is equivalent to setting <strong>--freeze-newlines</strong> and<strong>--freeze-whitespace</strong>.</html>"
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
360 EditorType=boolean
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
361 Enabled=false
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
362 TrueFalse=--indent-only|
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
363 ValueDefault=0
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
364
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
365 [Indent spaced block comments]
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
366 Category=4
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
367 Description="<html><dd><p>If there is no leading space on the line, then the comment will not be indented, and otherwise it may be.</p></dd><dd><p>If both <strong>-ibc</strong> and <strong>-isbc</strong> are set, then <strong>-isbc</strong> takes priority.</p></dd></html>"
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
368 EditorType=boolean
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
369 TrueFalse=-isbc|
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
370 ValueDefault=0
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
371
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
372 [List indentation]
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
373 Category=2
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
374 Description="<html>By default, perltidy indents lists with 4 spaces, or whatever value is specified with <strong>-i=n</strong>. Here is a small list formatted in this way:</p></dd><dd><pre>\n # perltidy (default)\n @month_of_year = (\n 'Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun',\n 'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec'\n );</pre></dd><dd><p>Use the <strong>-lp</strong> 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></dd><dd><pre>\n # perltidy -lp\n @month_of_year = (\n 'Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun',\n 'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec'\n );</pre></dd><dd><p>If the available line length (see <strong>-l=n</strong> ) does not permit this much space, perltidy will use less. For alternate placement of the closing paren, see the next section.</p></dd><dd><p>This option has no effect on code BLOCKS, such as if/then/else blocks, which always use whatever is specified with <strong>-i=n</strong>. Also, the existence of line breaks and/or block comments between the opening and closing parens may cause perltidy to temporarily revert to its default method.</p></dd><dd><p>Note: The <strong>-lp</strong> option may not be used together with the <strong>-t</strong> tabs option. It may, however, be used with the <strong>-et=n</strong> tab method.</p></dd><dd><p>In addition, any parameter which significantly restricts the ability of perltidy to choose newlines will conflict with <strong>-lp</strong> and will cause <strong>-lp</strong> to be deactivated. These include <strong>-io</strong>, <strong>-fnl</strong>, <strong>-nanl</strong>, and <strong>-ndnl</strong>. The reason is that the <strong>-lp</strong> indentation style can require the careful coordination of an arbitrary number of break points in hierarchical lists, and these flags may prevent that.</html>"
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
375 EditorType=boolean
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
376 TrueFalse=--line-up-parentheses|
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
377 ValueDefault=0
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
378
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
379 [Maximum line length]
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
380 CallName="--maximum-line-length="
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
381 Category=1
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
382 Description="<html>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. Setting <strong>-l=0</strong> is equivalent to setting <strong>-l=(a large number)</strong>.</html>"
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
383 EditorType=numeric
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
384 Enabled=false
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
385 MaxVal=1000
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
386 MinVal=0
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
387 ValueDefault=80
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
388
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
389 [Minimum space to comment]
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
390 CallName="--minimum-space-to-comment="
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
391 Category=4
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
392 Description="<html><dd><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></dd></html>"
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
393 EditorType=numeric
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
394 Enabled=false
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
395 MaxVal=1000
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
396 MinVal=0
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
397 ValueDefault=4
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
398
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
399 [Nospace after keyword]
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
400 CallName="--nospace-after-keyword="
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
401 Category=3
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
402 Description="<html><dd><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></dd><dd><pre>\n my local our and or eq ne if else elsif until unless \n while for foreach return switch case given when</pre></dd><dd><p>These defaults can be modified with two commands:</p></dd><dd><p><strong>-sak=s</strong> or <strong>--space-after-keyword=s</strong> adds keywords.</p></dd><dd><p><strong>-nsak=s</strong> or <strong>--nospace-after-keyword=s</strong> removes keywords.</p></dd><dd><p>where <strong>s</strong> is a list of keywords (in quotes if necessary). For example,</p></dd><dd><pre>\n my ( $a, $b, $c ) = @_; # default\n my( $a, $b, $c ) = @_; # -nsak=&quot;my local our&quot;</pre></dd></html>"
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
403 EditorType=string
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
404 Enabled=false
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
405 ValueDefault=
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
406
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
407 [Nowant left space]
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
408 CallName="--nowant-left-space="
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
409 Category=3
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
410 Description="<html><dd><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></dd><dd><p><strong>-wls=s</strong> or <strong>--want-left-space=s</strong>,</p></dd><dd><p><strong>-nwls=s</strong> or <strong>--nowant-left-space=s</strong>,</p></dd><dd><p><strong>-wrs=s</strong> or <strong>--want-right-space=s</strong>,</p></dd><dd><p><strong>-nwrs=s</strong> or <strong>--nowant-right-space=s</strong>.</p></dd><dd><p>These parameters are each followed by a quoted string, <strong>s</strong>, 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></dd><dd><p>To illustrate how these are used, suppose it is desired that there be no space on either side of the token types <strong>= + - / *</strong>. The following two parameters would specify this desire:</p></dd><dd><pre>\n -nwls=&quot;= + - / *&quot; -nwrs=&quot;= + - / *&quot;</pre></dd><dd><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></dd><dd><pre>\n $root = -$b + sqrt( $b * $b - 4. * $a * $c ) / ( 2. * $a );</pre></dd><dd><p>becomes this:</p></dd><dd><pre>\n $root=-$b+sqrt( $b*$b-4.*$a*$c )/( 2.*$a );</pre></dd><dd><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't. In this case, the token not wanting a space takes priority.</p></dd><dd><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 <strong>--dump-token-types</strong>. Also try the <strong>-D</strong> flag on a short snippet of code and look at the .DEBUG file to see the tokenization.</p></dd><dd><p><strong>WARNING</strong> Be sure to put these tokens in quotes to avoid having them misinterpreted by your command shell.</p></dd></html>"
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
411 EditorType=string
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
412 Enabled=false
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
413 ValueDefault=
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
414
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
415 [Nowant right space]
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
416 CallName="--nowant-right-space="
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
417 Category=3
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
418 Description="<html><dd><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></dd><dd><p><strong>-wls=s</strong> or <strong>--want-left-space=s</strong>,</p></dd><dd><p><strong>-nwls=s</strong> or <strong>--nowant-left-space=s</strong>,</p></dd><dd><p><strong>-wrs=s</strong> or <strong>--want-right-space=s</strong>,</p></dd><dd><p><strong>-nwrs=s</strong> or <strong>--nowant-right-space=s</strong>.</p></dd><dd><p>These parameters are each followed by a quoted string, <strong>s</strong>, 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></dd><dd><p>To illustrate how these are used, suppose it is desired that there be no space on either side of the token types <strong>= + - / *</strong>. The following two parameters would specify this desire:</p></dd><dd><pre>\n -nwls=&quot;= + - / *&quot; -nwrs=&quot;= + - / *&quot;</pre></dd><dd><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></dd><dd><pre>\n $root = -$b + sqrt( $b * $b - 4. * $a * $c ) / ( 2. * $a );</pre></dd><dd><p>becomes this:</p></dd><dd><pre>\n $root=-$b+sqrt( $b*$b-4.*$a*$c )/( 2.*$a );</pre></dd><dd><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't. In this case, the token not wanting a space takes priority.</p></dd><dd><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 <strong>--dump-token-types</strong>. Also try the <strong>-D</strong> flag on a short snippet of code and look at the .DEBUG file to see the tokenization.</p></dd><dd><p><strong>WARNING</strong> Be sure to put these tokens in quotes to avoid having them misinterpreted by your command shell.</p></dd></html>"
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
419 EditorType=string
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
420 Enabled=false
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
421 ValueDefault=
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
422
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
423 [Opening brace always on right]
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
424 Category=6
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
425 Description="<html><dd><p>The default style, <strong>-nbl</strong> 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></dd><dd><pre>\n if ( $bigwasteofspace1 &amp;&amp; $bigwasteofspace2\n || $bigwasteofspace3 &amp;&amp; $bigwasteofspace4 )\n {\n big_waste_of_time();\n }</pre></dd><dd><p>To force the opening brace to always be on the right, use the <strong>-bar</strong> flag. In this case, the above example becomes</p></dd><dd><pre>\n if ( $bigwasteofspace1 &amp;&amp; $bigwasteofspace2\n || $bigwasteofspace3 &amp;&amp; $bigwasteofspace4 ) {\n big_waste_of_time();\n }</pre></dd><dd><p>A conflict occurs if both <strong>-bl</strong> and <strong>-bar</strong> are specified.</p></dd></html>"
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
426 EditorType=boolean
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
427 TrueFalse=-bar|
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
428 ValueDefault=0
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
429
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
430 [Opening brace on new line]
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
431 Category=6
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
432 Description="<html><dd><p>Use the flag <strong>-bl</strong> to place the opening brace on a new line:</p></dd><dd><pre>\n if ( $input_file eq '-' ) # -bl \n { \n important_function();\n }</pre></dd><dd><p>This flag applies to all structural blocks, including sub's (unless the <strong>-sbl</strong> flag is set -- see next item).</p></dd><dd><p>The default style, <strong>-nbl</strong>, places an opening brace on the same line as the keyword introducing it. For example,</p></dd><dd><pre>\n if ( $input_file eq '-' ) { # -nbl (default)</pre></dd></html>"
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
433 EditorType=boolean
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
434 TrueFalse=-bl|-nbl
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
435 ValueDefault=0
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
436
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
437 [Opening hash brace right]
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
438 Category=6
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
439 Description="<html><dd><p>The <strong>-otr</strong> flag is a hint that perltidy should not place a break between a comma and an opening token. For example:</p></dd><dd><pre>\n # default formatting\n push @{ $self-&gt;{$module}{$key} },\n {\n accno =&gt; $ref-&gt;{accno},\n description =&gt; $ref-&gt;{description}\n };</pre></dd><dd><pre>\n # perltidy -otr\n push @{ $self-&gt;{$module}{$key} }, {\n accno =&gt; $ref-&gt;{accno},\n description =&gt; $ref-&gt;{description}\n };</pre></dd><dd><p>The flag <strong>-otr</strong> is actually a synonym for three other flags which can be used to control parens, hash braces, and square brackets separately if desired:</p></dd><dd><pre>\n -opr or --opening-paren-right\n -ohbr or --opening-hash-brace-right\n -osbr or --opening-square-bracket-right</pre></dd></html>"
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
440 EditorType=boolean
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
441 TrueFalse=-ohbr|
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
442 ValueDefault=0
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
443
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
444 [Opening paren right]
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
445 Category=6
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
446 Description="<html><dd><p>The <strong>-otr</strong> flag is a hint that perltidy should not place a break between a comma and an opening token. For example:</p></dd><dd><pre>\n # default formatting\n push @{ $self-&gt;{$module}{$key} },\n {\n accno =&gt; $ref-&gt;{accno},\n description =&gt; $ref-&gt;{description}\n };</pre></dd><dd><pre>\n # perltidy -otr\n push @{ $self-&gt;{$module}{$key} }, {\n accno =&gt; $ref-&gt;{accno},\n description =&gt; $ref-&gt;{description}\n };</pre></dd><dd><p>The flag <strong>-otr</strong> is actually a synonym for three other flags which can be used to control parens, hash braces, and square brackets separately if desired:</p></dd><dd><pre>\n -opr or --opening-paren-right\n -ohbr or --opening-hash-brace-right\n -osbr or --opening-square-bracket-right</pre></dd></html>"
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
447 EditorType=boolean
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
448 TrueFalse=-opr|
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
449 ValueDefault=0
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
450
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
451 [Opening square bracket right]
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
452 Category=6
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
453 Description="<html><dd><p>The <strong>-otr</strong> flag is a hint that perltidy should not place a break between a comma and an opening token. For example:</p></dd><dd><pre>\n # default formatting\n push @{ $self-&gt;{$module}{$key} },\n {\n accno =&gt; $ref-&gt;{accno},\n description =&gt; $ref-&gt;{description}\n };</pre></dd><dd><pre>\n # perltidy -otr\n push @{ $self-&gt;{$module}{$key} }, {\n accno =&gt; $ref-&gt;{accno},\n description =&gt; $ref-&gt;{description}\n };</pre></dd><dd><p>The flag <strong>-otr</strong> is actually a synonym for three other flags which can be used to control parens, hash braces, and square brackets separately if desired:</p></dd><dd><pre>\n -opr or --opening-paren-right\n -ohbr or --opening-hash-brace-right\n -osbr or --opening-square-bracket-right</pre></dd></html>"
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
454 EditorType=boolean
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
455 TrueFalse=-osbr|
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
456 ValueDefault=0
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
457
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
458 [Opening sub brace on new line]
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
459 Category=6
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
460 Description="<html><dd><p>The flag <strong>-sbl</strong> can be used to override the value of <strong>-bl</strong> for opening sub braces. For example,</p></dd><dd><pre>\n perltidy -sbl</pre></dd><dd><p>produces this result:</p></dd><dd><pre>\n sub message\n {\n if (!defined($_[0])) {\n print(&quot;Hello, World\n&quot;);\n }\n else {\n print($_[0], &quot;\n&quot;);\n }\n }</pre></dd><dd><p>This flag is negated with <strong>-nsbl</strong>. If <strong>-sbl</strong> is not specified, the value of <strong>-bl</strong> is used.</p></dd></html>"
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
461 EditorType=boolean
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
462 TrueFalse=-sbl|-nsbl
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
463 ValueDefault=0
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
464
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
465 [Opening anonymous sub brace on new line]
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
466 Category=6
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
467 Description="<html><p>The flag <strong>-asbl</strong> is like the <strong>-sbl</strong> flag except that it applies to anonymous sub's instead of named subs. For example</p><pre>\n perltidy -asbl</pre><p>produces this result:</p><pre>\n $a = sub\n {\n if ( !defined( $_[0] ) ) {\n print(&quot;Hello, World\n&quot;);\n }\n else {\n print( $_[0], &quot;\n&quot; );\n }\n };</pre><p>This flag is negated with <strong>-nasbl</strong>, and the default is <strong>-nasbl</strong>.</p></html>"
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
468 EditorType=boolean
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
469 TrueFalse=-asbl|-nasbl
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
470 ValueDefault=0
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
471
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
472 [Opening token right]
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
473 Category=6
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
474 Description="<html><dd><p>The <strong>-otr</strong> flag is a hint that perltidy should not place a break between a comma and an opening token. For example:</p></dd><dd><pre>\n # default formatting\n push @{ $self-&gt;{$module}{$key} },\n {\n accno =&gt; $ref-&gt;{accno},\n description =&gt; $ref-&gt;{description}\n };</pre></dd><dd><pre>\n # perltidy -otr\n push @{ $self-&gt;{$module}{$key} }, {\n accno =&gt; $ref-&gt;{accno},\n description =&gt; $ref-&gt;{description}\n };</pre></dd><dd><p>The flag <strong>-otr</strong> is actually a synonym for three other flags which can be used to control parens, hash braces, and square brackets separately if desired:</p></dd><dd><pre>\n -opr or --opening-paren-right\n -ohbr or --opening-hash-brace-right\n -osbr or --opening-square-bracket-right</pre></dd></html>"
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
475 EditorType=boolean
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
476 TrueFalse=-otr|
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
477 ValueDefault=0
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
478
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
479 [Outdent keyword list]
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
480 CallName="--outdent-keyword-list="
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
481 Category=2
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
482 Description="<html>This command can be used to change the keywords which are outdented with the <strong>-okw</strong> command. The parameter <strong>string</strong> 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 <strong>-okw</strong> command is still required.</p></dd><dd><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 <strong>-okwl</strong> command in a <em>.perltidyrc</em> file.</html>"
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
483 EditorType=string
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
484 Enabled=false
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
485 ValueDefault=
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
486
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
487 [Outdent long comments]
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
488 Category=4
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
489 Description="<html><dd><p>When <strong>-olc</strong> is set, lines which are full-line (block) comments longer than the value <strong>maximum-line-length</strong> will have their indentation removed. This is the default; use <strong>-nolc</strong> to prevent outdenting.</p></dd></html>"
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
490 EditorType=boolean
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
491 TrueFalse=-olc|-nolc
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
492 ValueDefault=1
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
493
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
494 [Outdent long lines]
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
495 Category=2
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
496 Description="<html>This command is equivalent to <strong>--outdent-long-quotes</strong> and <strong>--outdent-long-comments</strong>, and it is included for compatibility with previous versions of perltidy. The negation of this also works, <strong>-noll</strong> or <strong>--nooutdent-long-lines</strong>, and is equivalent to setting <strong>-nolq</strong> and <strong>-nolc</strong>.</html>"
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
497 EditorType=boolean
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
498 TrueFalse=--outdent-long-lines|
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
499 ValueDefault=0
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
500
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
501 [Outdent long quotes]
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
502 Category=2
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
503 Description="<html>When <strong>-olq</strong> is set, lines which is a quoted string longer than the value <strong>maximum-line-length</strong> will have their indentation removed to make them more readable. This is the default. To prevent such out-denting, use <strong>-nolq</strong> or <strong>--nooutdent-long-lines</strong>.</html>"
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
504 EditorType=boolean
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
505 TrueFalse=--outdent-long-quotes|
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
506 ValueDefault=0
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
507
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
508 [Outdenting Keywords]
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
509 Category=2
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
510 Description="<html>The command <strong>-okw</strong> will will cause certain leading control keywords to be outdented by 2 spaces (or whatever <strong>-ci</strong> 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></dd><dd><p>For example, using <code>perltidy -okw</code> on the previous example gives:</p></dd><dd><pre>\n my $i;\n LOOP: while ( $i = &lt;FOTOS&gt; ) {\n chomp($i);\n next unless $i;\n fixit($i);\n }</pre></dd><dd><p>The default is not to do this.</html>"
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
511 EditorType=boolean
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
512 TrueFalse=--outdent-keywords|
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
513 ValueDefault=0
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
514
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
515 [Outdenting Labels]
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
516 Category=2
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
517 Description="<html>This command will cause labels to be outdented by 2 spaces (or whatever <strong>-ci</strong> has been set to), if possible. This is the default. For example:</p></dd><dd><pre>\n my $i;\n LOOP: while ( $i = &lt;FOTOS&gt; ) {\n chomp($i);\n next unless $i;\n fixit($i);\n }</pre></dd><dd><p>Use <strong>-nola</strong> to not outdent labels.</html>"
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
518 EditorType=boolean
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
519 TrueFalse=--outdent-labels|
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
520 ValueDefault=0
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
521
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
522 [Output line ending]
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
523 Category=1
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
524 Choices="--output-line-ending=win|--output-line-ending=dos|--output-line-ending=unix|--output-line-ending=mac"
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
525 ChoicesReadable=Output line ending Windows|Output line ending Dos|Output line ending Unix|Output line ending Mac
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
526 Description="<html>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.</html>"
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
527 EditorType=multiple
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
528 Enabled=false
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
529 ValueDefault=1
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
530
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
531 [Paren tightness]
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
532 CallName="--paren-tightness="
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
533 Category=3
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
534 Description="<html><p>The <strong>-pt=n</strong> or <strong>--paren-tightness=n</strong> parameter controls the space within parens. The example below shows the effect of the three possible values, 0, 1, and 2:</p></dd><dd><pre>\n if ( ( my $len_tab = length( $tabstr ) ) &gt; 0 ) { # -pt=0\n if ( ( my $len_tab = length($tabstr) ) &gt; 0 ) { # -pt=1 (default)\n if ((my $len_tab = length($tabstr)) &gt; 0) { # -pt=2</pre></dd><dd><p>When n is 0, there is always a space to the right of a '(' and to the left of a ')'. 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.</html>"
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
535 EditorType=numeric
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
536 Enabled=false
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
537 MaxVal=2
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
538 MinVal=0
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
539 ValueDefault=1
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
540
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
541 [Paren vertical tightness]
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
542 CallName="--paren-vertical-tightness="
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
543 Category=6
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
544 Description="<html><p>The <strong>-vt=n</strong> and <strong>-vtc=n</strong> 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><p>In fact, the parameter <strong>-vt=n</strong> is actually just an abbreviation for <strong>-pvt=n -bvt=n sbvt=n</strong>, and likewise <strong>-vtc=n</strong> is an abbreviation for <strong>-pvtc=n -bvtc=n sbvtc=n</strong>.</p></html>"
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
545 EditorType=numeric
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
546 Enabled=false
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
547 MaxVal=2
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
548 MinVal=0
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
549 ValueDefault=0
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
550
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
551 [Paren vertical tightness closing]
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
552 CallName="--paren-vertical-tightness-closing="
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
553 Category=6
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
554 Description="<html><p>The <strong>-vt=n</strong> and <strong>-vtc=n</strong> 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><p>In fact, the parameter <strong>-vt=n</strong> is actually just an abbreviation for <strong>-pvt=n -bvt=n sbvt=n</strong>, and likewise <strong>-vtc=n</strong> is an abbreviation for <strong>-pvtc=n -bvtc=n sbvtc=n</strong>.</p></html>"
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
555 EditorType=numeric
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
556 Enabled=false
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
557 MaxVal=2
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
558 MinVal=0
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
559 ValueDefault=0
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
560
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
561 [Perl best practices]
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
562 Category=0
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
563 Description="<html><dd><p><strong>-pbp</strong> is an abbreviation for the parameters in the book <strong>Perl Best Practices</strong> by Damian Conway:</p></dd><dd><pre>\n -l=78 -i=4 -ci=4 -st -se -vt=2 -cti=0 -pt=1 -bt=1 -sbt=1 -bbt=1 -nsfs -nolq\n -wbb=&quot;% + - * / x != == &gt;= &lt;= =~ !~ &lt; &gt; | &amp; = \n **= += *= &amp;= &lt;&lt;= &amp;&amp;= -= /= |= &gt;&gt;= ||= //= .= %= ^= x=&quot;</pre></dd><dd><p>Note that the -st and -se flags make perltidy act as a filter on one file only. These can be overridden with -nst and -nse if necessary.</p></dd></html>"
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
564 EditorType=boolean
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
565 Enabled=false
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
566 TrueFalse=--perl-best-practices --nostandard-output|
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
567 ValueDefault=0
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
568
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
569 [Perl syntax check flags]
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
570 CallName="--perl-syntax-check-flags="
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
571 Category=1
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
572 Description="<html>When perl is invoked to check syntax, the normal flags are <code>-c -T</code>. In addition, if the <strong>-x</strong> flag is given to perltidy, then perl will also be passed a <strong>-x</strong> flag. It should not normally be necessary to change these flags, but it can be done with the <strong>-pscf=s</strong> flag. For example, if the taint flag, <code>-T</code>, is not wanted, the flag could be set to be just <strong>-pscf=-c</strong>.</p></dd><dd><p>Perltidy will pass your string to perl with the exception that it willadd a <strong>-c</strong> and <strong>-x</strong> if appropriate. The <em>.LOG</em> file will show exactly what flags were passed to perl.</html>"
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
573 EditorType=string
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
574 Enabled=false
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
575 ValueDefault=
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
576
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
577 [Preserve line endings]
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
578 Category=1
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
579 Description="<html>This flag tells perltidy to write its output files with the same line endings as the input file, if possible. It should work for <strong>dos</strong>, <strong>unix</strong>, and <strong>mac</strong> 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.</html>"
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
580 EditorType=boolean
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
581 Enabled=false
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
582 TrueFalse=--preserve-line-endings|
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
583 ValueDefault=0
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
584
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
585 [Space after keyword]
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
586 CallName="--space-after-keyword="
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
587 Category=3
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
588 Description="<html><dd><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></dd><dd><pre>\n my local our and or eq ne if else elsif until unless \n while for foreach return switch case given when</pre></dd><dd><p>These defaults can be modified with two commands:</p></dd><dd><p><strong>-sak=s</strong> or <strong>--space-after-keyword=s</strong> adds keywords.</p></dd><dd><p><strong>-nsak=s</strong> or <strong>--nospace-after-keyword=s</strong> removes keywords.</p></dd><dd><p>where <strong>s</strong> is a list of keywords (in quotes if necessary). For example,</p></dd><dd><pre>\n my ( $a, $b, $c ) = @_; # default\n my( $a, $b, $c ) = @_; # -nsak=&quot;my local our&quot;</pre></dd></html>"
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
589 EditorType=string
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
590 Enabled=false
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
591 ValueDefault=
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
592
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
593 [Space for semicolon]
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
594 Category=3
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
595 Description="<html><dd><p>Semicolons within <strong>for</strong> 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 <strong>-nsfs</strong> or <strong>--nospace-for-semicolon</strong> to deactivate it.</p></dd><dd><pre>\n for ( @a = @$ap, $u = shift @a ; @a ; $u = $v ) { # -sfs (default)\n for ( @a = @$ap, $u = shift @a; @a; $u = $v ) { # -nsfs</pre></dd></html>"
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
596 EditorType=boolean
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
597 TrueFalse=--space-for-semicolon|
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
598 ValueDefault=0
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
599
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
600 [Space function paren]
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
601 Category=3
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
602 Description="<html><dd><p>When an opening paren follows a function the default is not to introduce a space. To cause a space to be introduced use:</p></dd><dd><p><strong>-sfp</strong> or <strong>--space-function-paren</strong></p></dd><dd><pre>\n myfunc( $a, $b, $c ); # default \n myfunc ( $a, $b, $c ); # -sfp</pre></dd><dd><p>You will probably also want to use the flag <strong>-skp</strong> (previous item) too.</p></dd></html>"
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
603 EditorType=boolean
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
604 TrueFalse=--space-function-paren|
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
605 ValueDefault=0
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
606
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
607 [Space keyword paren]
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
608 Category=3
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
609 Description="<html><dd><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></dd><dd><p><strong>-skp</strong> or <strong>--space-keyword-paren</strong></p></dd><dd><p>You will probably also want to use the flag <strong>-sfp</strong> (next item) too.</p></dd></html>"
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
610 EditorType=boolean
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
611 TrueFalse=--space-keyword-paren|
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
612 ValueDefault=0
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
613
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
614 [Space terminal semicolon]
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
615 Category=3
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
616 Description="<html><p>Some programmers prefer a space before all terminal semicolons. The default is for no such space, and is indicated with <strong>-nsts</strong> or <strong>--nospace-terminal-semicolon</strong>.</p></dd><dd><pre>\n $i = 1 ; # -sts\n $i = 1; # -nsts (default)</pre></dd></html>"
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
617 EditorType=boolean
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
618 TrueFalse=--space-terminal-semicolon|
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
619 ValueDefault=0
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
620
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
621 [Square bracket tightness]
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
622 CallName="--square-bracket-tightness="
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
623 Category=3
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
624 Description="<html><p>Likewise, the parameter <strong>-sbt=n</strong> or <strong>--square-bracket-tightness=n</strong> controls the space within square brackets, as illustrated below.</p></dd><dd><pre>\n $width = $col[ $j + $k ] - $col[ $j ]; # -sbt=0\n $width = $col[ $j + $k ] - $col[$j]; # -sbt=1 (default)\n $width = $col[$j + $k] - $col[$j]; # -sbt=2</pre></dd></html>"
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
625 EditorType=numeric
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
626 Enabled=false
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
627 MaxVal=2
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
628 MinVal=0
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
629 ValueDefault=1
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
630
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
631 [Square bracket vertical tightness]
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
632 CallName="--square-bracket-vertical-tightness="
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
633 Category=6
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
634 Description="<html><p>The <strong>-vt=n</strong> and <strong>-vtc=n</strong> 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><p>In fact, the parameter <strong>-vt=n</strong> is actually just an abbreviation for <strong>-pvt=n -bvt=n sbvt=n</strong>, and likewise <strong>-vtc=n</strong> is an abbreviation for <strong>-pvtc=n -bvtc=n sbvtc=n</strong>.</p></html>"
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
635 EditorType=numeric
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
636 Enabled=false
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
637 MaxVal=2
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
638 MinVal=0
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
639 ValueDefault=0
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
640
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
641 [Square bracket vertical tightness closing]
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
642 CallName="--square-bracket-vertical-tightness-closing="
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
643 Category=6
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
644 Description="<html><p>The <strong>-vt=n</strong> and <strong>-vtc=n</strong> 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><p>In fact, the parameter <strong>-vt=n</strong> is actually just an abbreviation for <strong>-pvt=n -bvt=n sbvt=n</strong>, and likewise <strong>-vtc=n</strong> is an abbreviation for <strong>-pvtc=n -bvtc=n sbvtc=n</strong>.</p></html>"
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
645 EditorType=numeric
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
646 Enabled=false
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
647 MaxVal=2
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
648 MinVal=0
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
649 ValueDefault=0
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
650
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
651 [Stack closing hash brace]
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
652 Category=6
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
653 Description="<html><dd><p>The <strong>-sct</strong> flag tells perltidy to ``stack'' closing tokens when possible to avoid lines with isolated closing tokens.</p></dd><dd><p>For example:</p></dd><dd><pre>\n # default\n $opt_c = Text::CSV_XS-&gt;new(\n {\n binary =&gt; 1,\n sep_char =&gt; $opt_c,\n always_quote =&gt; 1,\n }\n );</pre></dd><dd><pre>\n # -sct\n $opt_c = Text::CSV_XS-&gt;new(\n {\n binary =&gt; 1,\n sep_char =&gt; $opt_c,\n always_quote =&gt; 1,\n } );</pre></dd><dd><p>The <strong>-sct</strong> flag is somewhat similar to the <strong>-vtc</strong> flags, and in some cases it can give a similar result. The difference is that the <strong>-vtc</strong> flags try to avoid lines with leading opening tokens by ``hiding'' them at the end of a previous line, whereas the <strong>-sct</strong> 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></dd><dd><pre>\n # -vtc=2\n $opt_c = Text::CSV_XS-&gt;new(\n {\n binary =&gt; 1,\n sep_char =&gt; $opt_c,\n always_quote =&gt; 1, } );</pre></dd><dd><p>The flag <strong>-sct</strong> is a synonym for <strong>-scp -schb -scsb</strong>.</p></dd></html>"
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
654 EditorType=boolean
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
655 TrueFalse=-schb|
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
656 ValueDefault=0
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
657
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
658 [Stack closing paren]
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
659 Category=6
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
660 Description="<html><dd><p>The <strong>-sct</strong> flag tells perltidy to ``stack'' closing tokens when possible to avoid lines with isolated closing tokens.</p></dd><dd><p>For example:</p></dd><dd><pre>\n # default\n $opt_c = Text::CSV_XS-&gt;new(\n {\n binary =&gt; 1,\n sep_char =&gt; $opt_c,\n always_quote =&gt; 1,\n }\n );</pre></dd><dd><pre>\n # -sct\n $opt_c = Text::CSV_XS-&gt;new(\n {\n binary =&gt; 1,\n sep_char =&gt; $opt_c,\n always_quote =&gt; 1,\n } );</pre></dd><dd><p>The <strong>-sct</strong> flag is somewhat similar to the <strong>-vtc</strong> flags, and in some cases it can give a similar result. The difference is that the <strong>-vtc</strong> flags try to avoid lines with leading opening tokens by ``hiding'' them at the end of a previous line, whereas the <strong>-sct</strong> 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></dd><dd><pre>\n # -vtc=2\n $opt_c = Text::CSV_XS-&gt;new(\n {\n binary =&gt; 1,\n sep_char =&gt; $opt_c,\n always_quote =&gt; 1, } );</pre></dd><dd><p>The flag <strong>-sct</strong> is a synonym for <strong>-scp -schb -scsb</strong>.</p></dd></html>"
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
661 EditorType=boolean
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
662 TrueFalse=-scp|
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
663 ValueDefault=0
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
664
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
665 [Stack closing square bracket]
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
666 Category=6
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
667 Description="<html><dd><p>The <strong>-sct</strong> flag tells perltidy to ``stack'' closing tokens when possible to avoid lines with isolated closing tokens.</p></dd><dd><p>For example:</p></dd><dd><pre>\n # default\n $opt_c = Text::CSV_XS-&gt;new(\n {\n binary =&gt; 1,\n sep_char =&gt; $opt_c,\n always_quote =&gt; 1,\n }\n );</pre></dd><dd><pre>\n # -sct\n $opt_c = Text::CSV_XS-&gt;new(\n {\n binary =&gt; 1,\n sep_char =&gt; $opt_c,\n always_quote =&gt; 1,\n } );</pre></dd><dd><p>The <strong>-sct</strong> flag is somewhat similar to the <strong>-vtc</strong> flags, and in some cases it can give a similar result. The difference is that the <strong>-vtc</strong> flags try to avoid lines with leading opening tokens by ``hiding'' them at the end of a previous line, whereas the <strong>-sct</strong> 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></dd><dd><pre>\n # -vtc=2\n $opt_c = Text::CSV_XS-&gt;new(\n {\n binary =&gt; 1,\n sep_char =&gt; $opt_c,\n always_quote =&gt; 1, } );</pre></dd><dd><p>The flag <strong>-sct</strong> is a synonym for <strong>-scp -schb -scsb</strong>.</p></dd></html>"
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
668 EditorType=boolean
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
669 TrueFalse=-scsb|
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
670 ValueDefault=0
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
671
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
672 [Stack closing tokens]
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
673 Category=6
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
674 Description="<html><dd><p>The <strong>-sct</strong> flag tells perltidy to ``stack'' closing tokens when possible to avoid lines with isolated closing tokens.</p></dd><dd><p>For example:</p></dd><dd><pre>\n # default\n $opt_c = Text::CSV_XS-&gt;new(\n {\n binary =&gt; 1,\n sep_char =&gt; $opt_c,\n always_quote =&gt; 1,\n }\n );</pre></dd><dd><pre>\n # -sct\n $opt_c = Text::CSV_XS-&gt;new(\n {\n binary =&gt; 1,\n sep_char =&gt; $opt_c,\n always_quote =&gt; 1,\n } );</pre></dd><dd><p>The <strong>-sct</strong> flag is somewhat similar to the <strong>-vtc</strong> flags, and in some cases it can give a similar result. The difference is that the <strong>-vtc</strong> flags try to avoid lines with leading opening tokens by ``hiding'' them at the end of a previous line, whereas the <strong>-sct</strong> 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></dd><dd><pre>\n # -vtc=2\n $opt_c = Text::CSV_XS-&gt;new(\n {\n binary =&gt; 1,\n sep_char =&gt; $opt_c,\n always_quote =&gt; 1, } );</pre></dd><dd><p>For detailed control of the stacking of individual closing tokens the following controls can be used:</p></dd><dd><pre>\n -scp or --stack-closing-paren\n -schb or --stack-closing-hash-brace\n -scsb or --stack-closing-square-bracket</pre></dd><dd><p>The flag <strong>-sct</strong> is a synonym for <strong>-scp -schb -scsb</strong>.</p></dd></html>"
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
675 EditorType=boolean
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
676 TrueFalse=-sct|
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
677 ValueDefault=0
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
678
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
679 [Stack opening hash brace]
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
680 Category=6
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
681 Description="<html><dd><p>The <strong>-sot</strong> flag tells perltidy to ``stack'' opening tokens when possible to avoid lines with isolated opening tokens.</p></dd><dd><p>For example:</p></dd><dd><pre>\n # default\n $opt_c = Text::CSV_XS-&gt;new(\n {\n binary =&gt; 1,\n sep_char =&gt; $opt_c,\n always_quote =&gt; 1,\n }\n );</pre></dd><dd><pre>\n # -sot\n $opt_c = Text::CSV_XS-&gt;new( {\n binary =&gt; 1,\n sep_char =&gt; $opt_c,\n always_quote =&gt; 1,\n }\n );</pre></dd><dd><p>For detailed control of individual closing tokens the following controls can be used:</p></dd><dd><pre>\n -sop or --stack-opening-paren\n -sohb or --stack-opening-hash-brace\n -sosb or --stack-opening-square-bracket</pre></dd><dd><p>The flag <strong>-sot</strong> is a synonym for <strong>-sop -sohb -sosb</strong>.</p></dd></html>"
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
682 EditorType=boolean
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
683 TrueFalse=-sohb|
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
684 ValueDefault=0
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
685
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
686 [Stack opening paren]
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
687 Category=6
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
688 Description="<html><dd><p>The <strong>-sot</strong> flag tells perltidy to ``stack'' opening tokens when possible to avoid lines with isolated opening tokens.</p></dd><dd><p>For example:</p></dd><dd><pre>\n # default\n $opt_c = Text::CSV_XS-&gt;new(\n {\n binary =&gt; 1,\n sep_char =&gt; $opt_c,\n always_quote =&gt; 1,\n }\n );</pre></dd><dd><pre>\n # -sot\n $opt_c = Text::CSV_XS-&gt;new( {\n binary =&gt; 1,\n sep_char =&gt; $opt_c,\n always_quote =&gt; 1,\n }\n );</pre></dd><dd><p>The flag <strong>-sot</strong> is a synonym for <strong>-sop -sohb -sosb</strong>.</p></dd></html>"
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
689 EditorType=boolean
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
690 TrueFalse=-sop|
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
691 ValueDefault=0
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
692
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
693 [Stack opening square bracket]
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
694 Category=6
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
695 Description="<html><dd><p>The <strong>-sot</strong> flag tells perltidy to ``stack'' opening tokens when possible to avoid lines with isolated opening tokens.</p></dd><dd><p>For example:</p></dd><dd><pre>\n # default\n $opt_c = Text::CSV_XS-&gt;new(\n {\n binary =&gt; 1,\n sep_char =&gt; $opt_c,\n always_quote =&gt; 1,\n }\n );</pre></dd><dd><pre>\n # -sot\n $opt_c = Text::CSV_XS-&gt;new( {\n binary =&gt; 1,\n sep_char =&gt; $opt_c,\n always_quote =&gt; 1,\n }\n );</pre></dd><dd><p>For detailed control of individual closing tokens the following controls can be used:</p></dd><dd><pre>\n -sop or --stack-opening-paren\n -sohb or --stack-opening-hash-brace\n -sosb or --stack-opening-square-bracket</pre></dd><dd><p>The flag <strong>-sot</strong> is a synonym for <strong>-sop -sohb -sosb</strong>.</p></dd></html>"
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
696 EditorType=boolean
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
697 TrueFalse=-sosb|
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
698 ValueDefault=0
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
699
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
700 [Stack opening tokens]
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
701 Category=6
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
702 Description="<html><dd><p>The <strong>-sot</strong> flag tells perltidy to ``stack'' opening tokens when possible to avoid lines with isolated opening tokens.</p></dd><dd><p>For example:</p></dd><dd><pre>\n # default\n $opt_c = Text::CSV_XS-&gt;new(\n {\n binary =&gt; 1,\n sep_char =&gt; $opt_c,\n always_quote =&gt; 1,\n }\n );</pre></dd><dd><pre>\n # -sot\n $opt_c = Text::CSV_XS-&gt;new( {\n binary =&gt; 1,\n sep_char =&gt; $opt_c,\n always_quote =&gt; 1,\n }\n );</pre></dd><dd><p>For detailed control of individual closing tokens the following controls can be used:</p></dd><dd><pre>\n -sop or --stack-opening-paren\n -sohb or --stack-opening-hash-brace\n -sosb or --stack-opening-square-bracket</pre></dd><dd><p>The flag <strong>-sot</strong> is a synonym for <strong>-sop -sohb -sosb</strong>.</p></dd></html>"
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
703 EditorType=boolean
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
704 TrueFalse=-sot|
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
705 ValueDefault=0
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
706
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
707 [Starting indentation level]
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
708 CallName="--starting-indentation-level="
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
709 Category=2
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
710 Description="<html>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. If the default method does not work correctly, or you want to change the starting level, use <strong>-sil=n</strong>, to force the starting level to be n.</html>"
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
711 EditorType=numeric
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
712 Enabled=false
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
713 MaxVal=1000
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
714 MinVal=0
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
715 ValueDefault=0
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
716
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
717 [Static Block Comment Outdent]
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
718 Category=4
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
719 Description="<html><dd><p>The command <strong>-osbc</strong> will will cause static block comments to be outdented by 2 spaces (or whatever <strong>-ci=n</strong> has been set to), if possible.</p></dd></html>"
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
720 EditorType=boolean
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
721 TrueFalse=-osbc|
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
722 ValueDefault=0
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
723
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
724 [Static Block Comment Prefix]
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
725 CallName="--static-block-comment-prefix="
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
726 Category=4
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
727 Description="<html><dd><p>This parameter defines the prefix used to identify static block comments when the <strong>-sbc</strong> 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 ^* 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='^#'</code>.</p></dd><dd><p>Please note that <strong>-sbcp</strong> merely defines the pattern used to identify static block comments; it will not be used unless the switch <strong>-sbc</strong> 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></dd><dd><p>A pattern which can be useful is:</p></dd><dd><pre>\n -sbcp=^#{2,}[^#]</pre></dd><dd><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 '#' 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 '#'.</p></dd></html>"
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
728 EditorType=string
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
729 Enabled=false
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
730 ValueDefault=##
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
731
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
732 [Static Block Comments]
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
733 Category=4
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
734 Description="<html><dd><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></dd><dl><dt><strong><a name=item__2dsbc_2c__2d_2dstatic_2dblock_2dcomments><strong>-sbc</strong>, <strong>--static-block-comments</strong></a></strong><dd><p>When <strong>-sbc</strong> is used, a block comment with a special leading pattern, <code>##</code> by default, will be treated specially.</p></dd><dd><p>Comments so identified are treated as follows:</p></dd><ul><li><p>If there is no leading space on the line, then the comment will not be indented, and otherwise it may be,</p></li><li><p>no new blank line will be inserted before such a comment, and</p></li><li><p>such a comment will never become a hanging side comment.</p></li></ul><p>For example, assuming <code>@month_of_year</code> is left-adjusted:</p><pre>\n @month_of_year = ( # -sbc (default)\n 'Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun', 'Jul', 'Aug', 'Sep', 'Oct',\n ## 'Dec', 'Nov'\n 'Nov', 'Dec');</pre><p>Without this convention, the above code would become</p><pre>\n @month_of_year = ( # -nsbc\n 'Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun', 'Jul', 'Aug', 'Sep', 'Oct',\n \n ## 'Dec', 'Nov'\n 'Nov', 'Dec'\n );</pre> <p>which is not as clear. The default is to use <strong>-sbc</strong>. This may be deactivated with <strong>-nsbc</strong>.</p></html>"
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
735 EditorType=boolean
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
736 TrueFalse=-sbc|-nsbc
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
737 ValueDefault=1
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
738
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
739 [Static Side Comment Prefix]
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
740 CallName="--static-side-comment-prefix="
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
741 Category=4
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
742 Description="<html><dd><p>This parameter defines the prefix used to identify static side comments when the <strong>-ssc</strong> parameter is set. The default prefix is <code>##</code>, corresponding to <code>-sscp=##</code>.</p></dd><dd><p>Please note that <strong>-sscp</strong> merely defines the pattern used to identify static side comments; it will not be used unless the switch <strong>-ssc</strong> 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></dd></html>"
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
743 EditorType=string
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
744 Enabled=false
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
745 ValueDefault=##
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
746
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
747 [Static Side Comments]
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
748 Category=4
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
749 Description="<html><dd><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></dd><dl><dt><strong><a name=item__2dssc_2c__2d_2dstatic_2dside_2dcomments><strong>-ssc</strong>, <strong>--static-side-comments</strong></a></strong><dd><p>When <strong>-ssc</strong> is used, a side comment with a static leading pattern, which is <code>##</code> by default, will be be spaced only a single space from previous character, and it will not be vertically aligned with other side comments.</p></dd><dd><p>The default is <strong>-nssc</strong>.</p></dd></html>"
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
750 EditorType=boolean
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
751 TrueFalse=-ssc|-nssc
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
752 ValueDefault=0
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
753
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
754 [Tabs]
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
755 Category=1
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
756 Description="<html>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 <strong>-lp</strong> option.</html>"
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
757 EditorType=boolean
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
758 TrueFalse=--tabs|
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
759 ValueDefault=0
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
760
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
761 [Trimming whitespace around qw quotes]
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
762 Category=3
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
763 Choices=--trim-qw|--notrim-qw
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
764 ChoicesReadable=Trim whitespace|Do not trim whitespace
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
765 Description="<html><dd><p><strong>-tqw</strong> or <strong>--trim-qw</strong> provide the default behavior of trimming spaces around multi-line <code>qw</code> quotes and indenting them appropriately.</p></dd><dd><p><strong>-ntqw</strong> or <strong>--notrim-qw</strong> 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></dd></html>"
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
766 EditorType=multiple
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
767 Enabled=false
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
768 ValueDefault=0
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
769
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
770 [Vertical tightness]
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
771 CallName="--vertical-tightness="
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
772 Category=6
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
773 Description="<html><p>Opening tokens (except for block braces) are controlled by <strong>-vt=n</strong>, or <strong>--vertical-tightness=n</strong>, where</p><pre>\n -vt=0 always break a line after opening token (default). \n -vt=1 do not break unless this would produce more than one \n step in indentation in a line.\n -vt=2 never break a line after opening token</pre><p>You must also use the <strong>-lp</strong> flag when you use the <strong>-vt</strong> flag; the reason is explained below.</p></html>"
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
774 EditorType=numeric
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
775 Enabled=false
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
776 MaxVal=2
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
777 MinVal=0
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
778 ValueDefault=0
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
779
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
780 [Vertical tightness closing]
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
781 CallName="--vertical-tightness-closing="
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
782 Category=6
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
783 Description="<html><p>Closing tokens (except for block braces) are controlled by <strong>-vtc=n</strong>, or <strong>--vertical-tightness-closing=n</strong>, where</p><pre>\n -vtc=0 always break a line before a closing token (default), \n -vtc=1 do not break before a closing token which is followed \n by a semicolon or another closing token, and is not in \n a list environment.\n -vtc=2 never break before a closing token.</pre><p>The rules for <strong>-vtc=1</strong> are designed to maintain a reasonable balance between tightness and readability in complex lists.</p></html>"
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
784 EditorType=numeric
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
785 Enabled=false
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
786 MaxVal=2
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
787 MinVal=0
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
788 ValueDefault=0
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
789
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
790 [Want break after]
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
791 CallName="--want-break-after="
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
792 Category=6
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
793 Description="<html><dd><p>These parameters are each followed by a quoted string, <strong>s</strong>, 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></dd><dd><p>By default, perltidy breaks <strong>after</strong> these token types: % + - * / x != == &gt;= &lt;= =~ !~ &lt; &gt; | &amp; = **= += *= &amp;= &lt;&lt;= &amp;&amp;= -= /= |= &gt;&gt;= ||= //= .= %= ^= x=</p></dd><dd><p>And perltidy breaks <strong>before</strong> these token types by default: . &lt;&lt; &gt;&gt; -&gt; &amp;&amp; || //</p></dd><dd><p>To illustrate, to cause a break after a concatenation operator, <code>'.'</code>, rather than before it, the command line would be</p></dd><dd><pre>\n -wba=&quot;.&quot;</pre></dd><dd><p>As another example, the following command would cause a break before math operators <code>'+'</code>, <code>'-'</code>, <code>'/'</code>, and <code>'*'</code>:</p></dd><dd><pre>\n -wbb=&quot;+ - / *&quot;</pre></dd><dd><p>These commands should work well for most of the token types that perltidy uses (use <strong>--dump-token-types</strong> for a list). Also try the <strong>-D</strong> 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 <strong>bl</strong> provided for that purpose.</p></dd></html>"
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
794 EditorType=string
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
795 Enabled=false
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
796 ValueDefault=
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
797
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
798 [Want break before]
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
799 CallName="--want-break-before="
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
800 Category=6
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
801 Description="<html><dd><p>These parameters are each followed by a quoted string, <strong>s</strong>, 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></dd><dd><p>By default, perltidy breaks <strong>after</strong> these token types: % + - * / x != == &gt;= &lt;= =~ !~ &lt; &gt; | &amp; = **= += *= &amp;= &lt;&lt;= &amp;&amp;= -= /= |= &gt;&gt;= ||= //= .= %= ^= x=</p></dd><dd><p>And perltidy breaks <strong>before</strong> these token types by default: . &lt;&lt; &gt;&gt; -&gt; &amp;&amp; || //</p></dd><dd><p>To illustrate, to cause a break after a concatenation operator, <code>'.'</code>, rather than before it, the command line would be</p></dd><dd><pre>\n -wba=&quot;.&quot;</pre></dd><dd><p>As another example, the following command would cause a break before math operators <code>'+'</code>, <code>'-'</code>, <code>'/'</code>, and <code>'*'</code>:</p></dd><dd><pre>\n -wbb=&quot;+ - / *&quot;</pre></dd><dd><p>These commands should work well for most of the token types that perltidy uses (use <strong>--dump-token-types</strong> for a list). Also try the <strong>-D</strong> 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 <strong>bl</strong> provided for that purpose.</p></dd></html>"
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
802 EditorType=string
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
803 Enabled=false
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
804 ValueDefault=
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
805
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
806 [Want left space]
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
807 CallName="--want-left-space="
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
808 Category=3
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
809 Description="<html><dd><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></dd><dd><p><strong>-wls=s</strong> or <strong>--want-left-space=s</strong>,</p></dd><dd><p><strong>-nwls=s</strong> or <strong>--nowant-left-space=s</strong>,</p></dd><dd><p><strong>-wrs=s</strong> or <strong>--want-right-space=s</strong>,</p></dd><dd><p><strong>-nwrs=s</strong> or <strong>--nowant-right-space=s</strong>.</p></dd><dd><p>These parameters are each followed by a quoted string, <strong>s</strong>, 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></dd><dd><p>To illustrate how these are used, suppose it is desired that there be no space on either side of the token types <strong>= + - / *</strong>. The following two parameters would specify this desire:</p></dd><dd><pre>\n -nwls=&quot;= + - / *&quot; -nwrs=&quot;= + - / *&quot;</pre></dd><dd><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></dd><dd><pre>\n $root = -$b + sqrt( $b * $b - 4. * $a * $c ) / ( 2. * $a );</pre></dd><dd><p>becomes this:</p></dd><dd><pre>\n $root=-$b+sqrt( $b*$b-4.*$a*$c )/( 2.*$a );</pre></dd><dd><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't. In this case, the token not wanting a space takes priority.</p></dd><dd><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 <strong>--dump-token-types</strong>. Also try the <strong>-D</strong> flag on a short snippet of code and look at the .DEBUG file to see the tokenization.</p></dd><dd><p><strong>WARNING</strong> Be sure to put these tokens in quotes to avoid having them misinterpreted by your command shell.</p></dd></html>"
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
810 EditorType=string
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
811 Enabled=false
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
812 ValueDefault=
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
813
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
814 [Want right space]
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
815 CallName="--want-right-space="
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
816 Category=3
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
817 Description="<html><dd><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></dd><dd><p><strong>-wls=s</strong> or <strong>--want-left-space=s</strong>,</p></dd><dd><p><strong>-nwls=s</strong> or <strong>--nowant-left-space=s</strong>,</p></dd><dd><p><strong>-wrs=s</strong> or <strong>--want-right-space=s</strong>,</p></dd><dd><p><strong>-nwrs=s</strong> or <strong>--nowant-right-space=s</strong>.</p></dd><dd><p>These parameters are each followed by a quoted string, <strong>s</strong>, 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></dd><dd><p>To illustrate how these are used, suppose it is desired that there be no space on either side of the token types <strong>= + - / *</strong>. The following two parameters would specify this desire:</p></dd><dd><pre>\n -nwls=&quot;= + - / *&quot; -nwrs=&quot;= + - / *&quot;</pre></dd><dd><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></dd><dd><pre>\n $root = -$b + sqrt( $b * $b - 4. * $a * $c ) / ( 2. * $a );</pre></dd><dd><p>becomes this:</p></dd><dd><pre>\n $root=-$b+sqrt( $b*$b-4.*$a*$c )/( 2.*$a );</pre></dd><dd><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't. In this case, the token not wanting a space takes priority.</p></dd><dd><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 <strong>--dump-token-types</strong>. Also try the <strong>-D</strong> flag on a short snippet of code and look at the .DEBUG file to see the tokenization.</p></dd><dd><p><strong>WARNING</strong> Be sure to put these tokens in quotes to avoid having them misinterpreted by your command shell.</p></dd></html>"
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
818 EditorType=string
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
819 Enabled=false
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
820 ValueDefault=
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
821
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
822 [Break at old comma breakpoints]
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
823 Category=7
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
824 Description="<html><dd><p>This flag tells perltidy to try to break at all old commas. This is not the default. Normally, perltidy makes a best guess at list formatting, and seldom uses old comma breakpoints. Usually this works well, but consider:</p></dd><dd><pre>\n my @list = (1,\n 1, 1,\n 1, 2, 1,\n 1, 3, 3, 1,\n 1, 4, 6, 4, 1,);</pre></dd><dd><p>The default formatting will flatten this down to one line:</p></dd><dd><pre>\n # perltidy (default)\n my @list = ( 1, 1, 1, 1, 2, 1, 1, 3, 3, 1, 1, 4, 6, 4, 1, );</pre></dd><dd><p>which hides the structure. Using <strong>-boc</strong>, plus additional flags to retain the original style, yields</p></dd><dd><pre>\n # perltidy -boc -lp -pt=2 -vt=1 -vtc=1\n my @list = (1,\n 1, 1,\n 1, 2, 1,\n 1, 3, 3, 1,\n 1, 4, 6, 4, 1,);</pre></dd><dd><p>A disadvantage of this flag is that all tables in the file must already be nicely formatted. For another possibility see the -fs flag in Skipping Selected Sections of Code.</p></dd></html>"
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
825 EditorType=boolean
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
826 TrueFalse=--break-at-old-comma-breakpoints|
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
827 ValueDefault=0
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
828
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
829 [Maximum fields per table]
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
830 CallName="--maximum-fields-per-table="
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
831 Category=7
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
832 Description="<html><dd><p>If the computed number of fields for any table exceeds <strong>n</strong>, then it will be reduced to <strong>n</strong>. The default value for <strong>n</strong> 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 <strong>-boc</strong> 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></dd><dd><pre>\n # perltidy -mft=2\n @month_of_year = ( \n 'Jan', 'Feb',\n 'Mar', 'Apr',\n 'May', 'Jun',\n 'Jul', 'Aug',\n 'Sep', 'Oct',\n 'Nov', 'Dec'\n );</pre></dd></html>"
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
833 EditorType=numeric
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
834 Enabled=false
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
835 MaxVal=9999
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
836 MinVal=0
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
837 ValueDefault=40
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
838
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
839 [Comma arrow breakpoints]
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
840 CallName="--comma-arrow-breakpoints="
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
841 Category=7
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
842 Description="<html><dd><p>A comma which follows a comma arrow, '=&gt;', requires 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 <strong>-boc</strong> is used). The possible values of <strong>n</strong> are:</p></dd><dd><pre>\n n=0 break at all commas after =&gt; \n n=1 stable: break at all commas after =&gt; unless this would break\n an existing one-line container (default)\n n=2 break at all commas after =&gt;, but try to form the maximum\n maximum one-line container lengths\n n=3 do not treat commas after =&gt; specially at all</pre></dd><dd><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></dd><dd><pre>\n bless { B =&gt; $B, Root =&gt; $Root } =&gt; $package;</pre></dd><dd><p>Using <strong>-cab=0</strong> will force a break after each comma-arrow item:</p></dd><dd><pre>\n # perltidy -cab=0:\n bless {\n B =&gt; $B,\n Root =&gt; $Root\n } =&gt; $package;</pre></dd><dd><p>If perltidy is subsequently run with this container broken, then by default it will break after each '=&gt;' because the container is now broken. To reform a one-line container, the parameter <strong>-cab=2</strong> would be needed.</p></dd><dd><p>The flag <strong>-cab=3</strong> can be used to prevent these commas from being treated specially. In this case, an item such as ``01'' =&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></dd><dd><pre>\n # perltidy -cab=3\n my %last_day = (\n &quot;01&quot; =&gt; 31, &quot;02&quot; =&gt; 29, &quot;03&quot; =&gt; 31, &quot;04&quot; =&gt; 30,\n &quot;05&quot; =&gt; 31, &quot;06&quot; =&gt; 30, &quot;07&quot; =&gt; 31, &quot;08&quot; =&gt; 31,\n &quot;09&quot; =&gt; 30, &quot;10&quot; =&gt; 31, &quot;11&quot; =&gt; 30, &quot;12&quot; =&gt; 31\n );</pre></dd></html>"
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
843 EditorType=numeric
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
844 Enabled=false
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
845 MaxVal=3
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
846 MinVal=0
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
847 ValueDefault=3
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
848
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
849 [Break at old logical breakpoints]
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
850 Category=8
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
851 Description="<html><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 <strong>-nbol</strong>.</p></html>"
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
852 EditorType=boolean
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
853 TrueFalse=--break-at-old-logical-breakpoints|
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
854 ValueDefault=0
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
855
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
856 [Break at old keyword breakpoints]
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
857 Category=8
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
858 Description="<html><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 <strong>-nbok</strong> to prevent retaining these breakpoints.</p></html>"
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
859 EditorType=boolean
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
860 TrueFalse=--break-at-old-keyword-breakpoints|
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
861 ValueDefault=0
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
862
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
863 [Break at old ternary breakpoints]
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
864 Category=8
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
865 Description="<html><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 <strong>-nbot</strong>.</p></html>"
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
866 EditorType=boolean
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
867 TrueFalse=--break-at-old-ternary-breakpoints|
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
868 ValueDefault=0
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
869
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
870 [Ignore old breakpoints]
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
871 Category=8
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
872 Description="<html><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.</p></html>"
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
873 EditorType=boolean
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
874 TrueFalse=--ignore-old-breakpoints|
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
875 ValueDefault=0
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
876
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
877 [Keep interior semicolons]
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
878 Category=8
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
879 Description="<html><dd><p>Use the <strong>-kis</strong> 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></dd><dd><pre>\n dbmclose(%verb_delim); undef %verb_delim;\n dbmclose(%expanded); undef %expanded;</pre></dd><dd><p>The default is to break after each statement, giving</p></dd><dd><pre>\n dbmclose(%verb_delim);\n undef %verb_delim;\n dbmclose(%expanded);\n undef %expanded;</pre></dd><dd><p>With <strong>perltidy -kis</strong> the multiple statements are retained:</p></dd><dd><pre>\n dbmclose(%verb_delim); undef %verb_delim;\n dbmclose(%expanded); undef %expanded;</pre></dd><dd><p>The statements are still subject to the specified value of <strong>maximum-line-length</strong> and will be broken if this maximum is exceeed.</p></dd></html>"
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
880 EditorType=boolean
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
881 TrueFalse=--keep-interior-semicolons|
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
882 ValueDefault=0
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
883
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
884 [Blanks before comments]
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
885 Category=9
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
886 Description="<html><p>A blank line will be introduced before a full-line comment. This is the default. Use <strong>-nbbc</strong> or <strong>--noblanks-before-comments</strong> to prevent such blank lines from being introduced.</p></html>"
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
887 EditorType=boolean
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
888 TrueFalse=--blanks-before-comments|
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
889 ValueDefault=0
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
890
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
891 [Blanks before subs]
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
892 Category=9
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
893 Description="<html><p>A blank line will be introduced before a <strong>sub</strong> definition, unless it is a one-liner or preceded by a comment. A blank line will also be introduced before a <strong>package</strong> statement and a <strong>BEGIN</strong> and <strong>END</strong> block. This is the default. The intention is to help display the structure of a program by setting off certain key sections of code. This is negated with <strong>-nbbs</strong> or <strong>--noblanks-before-subs</strong>.</p></html>"
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
894 EditorType=boolean
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
895 TrueFalse=--blanks-before-subs|
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
896 ValueDefault=0
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
897
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
898 [Blanks before blocks]
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
899 Category=9
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
900 Description="<html><dd><p>A blank line will be introduced before blocks of coding delimited by <strong>for</strong>, <strong>foreach</strong>, <strong>while</strong>, <strong>until</strong>, and <strong>if</strong>, <strong>unless</strong>, in the following circumstances:</p></dd><ul><li><p>The block is not preceded by a comment.</p></li><li><p>The block is not a one-line block.</p></li><li><p>The number of consecutive non-blank lines at the current indentation depth is at least <strong>-lbl</strong> (see next section).</p></li></ul><p>This is the default. The intention of this option is to introduce some space within dense coding. This is negated with <strong>-nbbb</strong> or <strong>--noblanks-before-blocks</strong>.</p></html>"
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
901 EditorType=boolean
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
902 TrueFalse=--blanks-before-blocks|
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
903 ValueDefault=0
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
904
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
905 [Long block line count]
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
906 CallName="--long-block-line-count="
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
907 Category=9
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
908 Description="<html><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 <strong>0</strong> is equivalent to entering a very large number.</p></html>"
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
909 EditorType=numeric
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
910 Enabled=false
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
911 MaxVal=9999
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
912 MinVal=0
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
913 ValueDefault=8
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
914
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
915 [Maximum consecutive blank lines]
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
916 CallName="--maximum-consecutive-blank-lines="
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
917 Category=9
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
918 Description="<html><p>This parameter specifies the maximum number of consecutive blank lines in the output script. The default is n=1. If the input file has more than n consecutive blank lines, the number will be reduced to n. (This obviously does not apply to pod sections, here-documents, and quotes).</p></html>"
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
919 EditorType=numeric
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
920 Enabled=false
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
921 MaxVal=9999
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
922 MinVal=0
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
923 ValueDefault=1
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
924
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
925 [Keep old blank lines]
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
926 CallName="--keep-old-blank-lines="
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
927 Category=9
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
928 Description="<html><p>The <strong>-kbl=n</strong> flag gives you control over how your existing blank lines are treated.</p><p>The possible values of <strong>n</strong> are:</p><pre>\n n=0 ignore all old blank lines\n n=1 stable: keep old blanks, but limited by the value of the B&lt;-mbl=n&gt; flag\n n=2 keep all old blank lines, regardless of the value of the B&lt;-mbl=n&gt; flag</pre><p>The default is <strong>n=1</strong>.</p></html>"
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
929 EditorType=numeric
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
930 Enabled=false
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
931 MaxVal=9999
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
932 MinVal=0
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
933 ValueDefault=1
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
934
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
935 [Swallow optional blank lines]
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
936 Category=9
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
937 Description="<html><p>All blank lines not required by the above flags, <strong>-bbb</strong>, <strong>-bbs</strong>, and <strong>-bbc</strong>, will be deleted. (But essential blank lines above pod documents will be retained). This is NOT the default.</p></html>"
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
938 EditorType=boolean
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
939 TrueFalse=--swallow-optional-blank-lines|
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
940 ValueDefault=0
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
941
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
942 [Noswallow optional blank lines]
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
943 Category=9
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
944 Description="<html><p>Retain blank lines, including those which do not corresponding to flags <strong>-bbb</strong>, <strong>-bbs</strong>, and <strong>-bbc</strong>. This is the default. The number of blanks retained is subject to the limit imposed by <strong>--maximum-consecutive-blank-lines</strong>, however.</p></html>"
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
945 EditorType=boolean
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
946 TrueFalse=--noswallow-optional-blank-lines|
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
947 ValueDefault=0
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
948
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
949 [Delete all comments]
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
950 Category=10
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
951 Description="<html><p>Perltidy can selectively delete comments and/or pod documentation. The command <strong>-dac</strong> or <strong>--delete-all-comments</strong> will delete all comments <strong>and</strong> all pod documentation, leaving just code and any leading system control lines.</p></html>"
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
952 EditorType=boolean
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
953 TrueFalse=--delete-all-comments|
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
954 ValueDefault=0
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
955
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
956 [Delete pod]
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
957 Category=10
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
958 Description="<html><p>The command <strong>-dp</strong> or <strong>--delete-pod</strong> will remove all pod documentation (but not comments).</p></html>"
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
959 EditorType=boolean
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
960 TrueFalse=--delete-pod|
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
961 ValueDefault=0
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
962
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
963 [Delete block comments]
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
964 Category=10
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
965 Description="<html><p>Two commands which remove comments (but not pod) are: <strong>-dbc</strong> or <strong>--delete-block-comments</strong> and <strong>-dsc</strong> or <strong>--delete-side-comments</strong>. (Hanging side comments will be deleted with block comments here.)</p></html>"
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
966 EditorType=boolean
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
967 TrueFalse=--delete-block-comments|
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
968 ValueDefault=0
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
969
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
970 [Delete side comments]
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
971 Category=10
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
972 Description="<html><p>Two commands which remove comments (but not pod) are: <strong>-dbc</strong> or <strong>--delete-block-comments</strong> and <strong>-dsc</strong> or <strong>--delete-side-comments</strong>. (Hanging side comments will be deleted with block comments here.)</p></html>"
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
973 EditorType=boolean
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
974 TrueFalse=--delete-side-comments|
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
975 ValueDefault=0
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
976
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
977 [Tee all comments]
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
978 Category=10
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
979 Description="<html><p>When perltidy writes a formatted text file, it has the ability to also send selected text to a file with a <em>.TEE</em> extension. This text can include comments and pod documentation.</p><p>The command <strong>-tac</strong> or <strong>--tee-all-comments</strong> will write all comments <strong>and</strong> all pod documentation.</p></html>"
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
980 EditorType=boolean
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
981 TrueFalse=--tee-all-comments|
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
982 ValueDefault=0
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
983
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
984 [Tee pod]
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
985 Category=10
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
986 Description="<html><p>When perltidy writes a formatted text file, it has the ability to also send selected text to a file with a <em>.TEE</em> extension. This text can include comments and pod documentation.</p><p>The command <strong>-tp</strong> or <strong>--tee-pod</strong> will write all pod documentation (but not comments).</p></html>"
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
987 EditorType=boolean
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
988 TrueFalse=--tee-pod|
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
989 ValueDefault=0
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
990
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
991 [Tee block comments]
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
992 Category=10
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
993 Description="<html><p>When perltidy writes a formatted text file, it has the ability to also send selected text to a file with a <em>.TEE</em> extension. This text can include comments and pod documentation.</p><p>The commands which write comments (but not pod) are: <strong>-tbc</strong> or <strong>--tee-block-comments</strong> and <strong>-tsc</strong> or <strong>--tee-side-comments</strong>. (Hanging side comments will be written with block comments here.)</p></html>"
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
994 EditorType=boolean
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
995 TrueFalse=--tee-block-comments|
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
996 ValueDefault=0
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
997
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
998 [Tee side comments]
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
999 Category=10
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
1000 Description="<html><p>When perltidy writes a formatted text file, it has the ability to also send selected text to a file with a <em>.TEE</em> extension. This text can include comments and pod documentation.</p><p>The commands which write comments (but not pod) are: <strong>-tbc</strong> or <strong>--tee-block-comments</strong> and <strong>-tsc</strong> or <strong>--tee-side-comments</strong>. (Hanging side comments will be written with block comments here.)</p></html>"
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
1001 EditorType=boolean
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
1002 TrueFalse=--tee-side-comments|
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
1003 ValueDefault=0
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
1004
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
1005 [Look for hash bang]
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
1006 Category=10
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
1007 Description="<html><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 ``hash-bang'' line, ( a line of the form <code>#!...perl</code> ), you must use the <strong>-x</strong> flag to tell perltidy not to parse and format any lines before the ``hash-bang'' 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></html>"
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
1008 EditorType=boolean
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
1009 TrueFalse=--look-for-hash-bang|
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
1010 ValueDefault=0
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
1011
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
1012 [Making a file unreadable]
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
1013 Category=10
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
1014 Choices=--mangle|--extrude
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
1015 ChoicesReadable=Mangle|Extrude
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
1016 Description="<html><dd><p>The goal of perltidy is to improve the readability of files, but there are two commands which have the opposite effect, <strong>--mangle</strong> and <strong>--extrude</strong>. 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 <strong>--mangle</strong> puts the fewest possible line breaks in a script while <strong>--extrude</strong> 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 <strong>--mangle</strong> is the following:</p></dd><dd><pre>\n perltidy --mangle myfile.pl -st | perltidy -o myfile.pl.new</pre></dd><dd><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></dd><dd><p>A similar technique can be used with <strong>--extrude</strong> instead of <strong>--mangle</strong> to make the minimum number of one-line blocks.</p></dd><dd><p>Another use for <strong>--mangle</strong> is to combine it with <strong>-dac</strong> to reduce the file size of a perl script.</p></dd></html>"
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
1017 EditorType=multiple
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
1018 Enabled=false
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
1019 ValueDefault=0
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
1020
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
1021 [MakeMaker]
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
1022 Category=10
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
1023 Description="<html><p>The first $VERSION line of a file which might be eval'd by MakeMaker is passed through unchanged except for indentation. Use --nopass-version-line, or -npvl, to deactivate this feature.</p></html>"
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
1024 EditorType=boolean
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
1025 TrueFalse=--nopass-version-line|
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
1026 ValueDefault=0
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
1027
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
1028 [AutoLoader]
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
1029 Category=10
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
1030 Description="<html><p>If the AutoLoader module is used, perltidy will continue formatting code after seeing an __END__ line. Use --nolook-for-autoloader, or -nlal, to deactivate this feature.</p></html>"
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
1031 EditorType=boolean
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
1032 TrueFalse=--nolook-for-autoloader|
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
1033 ValueDefault=0
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
1034
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
1035 [SelfLoader]
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
1036 Category=10
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
1037 Description="<html><p>Likewise, if the SelfLoader module is used, perltidy will continue formatting code after seeing a __DATA__ line. Use --nolook-for-selfloader, or -nlsl, to deactivate this feature.</p></html>"
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
1038 EditorType=boolean
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
1039 TrueFalse=--nolook-for-selfloader|
a0f609a86954 Updated the perltidy config file to suit for version 1.74 of perltidy.
thomas_-_s <thomas_-_s@59b1889a-e5ac-428c-b0c7-476e01d41282>
parents: 482
diff changeset
1040 ValueDefault=0