docs/index.html

   1 <h1>Welcome to Perltidy</h1>
   2
   3 <p>Perltidy is a Perl script which indents and reformats Perl scripts to make them
   4 easier to read.  If you write Perl scripts, or spend much time
   5 reading them, you will probably find it useful.</p>
   6
   7 <p>Perltidy is free software released under the GNU General Public
   8 License -- please see the included file <a href="../COPYING">COPYING</a> for details.</p>
   9
  10 <p>The formatting can be controlled with command line parameters.  The default
  11 parameter settings approximately follow the suggestions in the
  12 <a href="https://perldoc.perl.org/perlstyle.html">Perl Style Guide</a>.</p>
  13
  14 <p>Besides reformatting scripts, Perltidy can help in tracking
  15 down errors with missing or extra braces, parentheses, and square brackets
  16 because it is very good at localizing errors.</p>
  17
  18 <h2>Documentation</h2>
  19
  20 <ul>
  21 <li><p><a href="./tutorial.html">A Brief Perltidy Tutorial</a></p></li>
  22 <li><p><a href="./stylekey.html">Perltidy Style Key</a> will help
  23 in methodically selecting a set of style parameters.</p></li>
  24 <li><p><a href="./perltidy.html">The Perltidy man page</a> explains how
  25 to precisely control the formatting details.</p></li>
  26 <li><p><a href="./Tidy.html">The Perl::Tidy man page</a> discusses how to use the Perl::Tidy module</p></li>
  27 <li><p><a href="./ChangeLog.html">Change Log</a></p></li>
  28 </ul>
  29
  30 <h2>Prerequisites</h2>
  31
  32 <p>Perltidy should run on any system with perl 5.008 or later.
  33 The total disk space needed after removing the installation directory will be
  34 about 2 Mb.</p>
  35
  36 <h2>Download</h2>
  37
  38 <ul>
  39 <li><p>The most recent release is always at <a href="https://metacpan.org/release/Perl-Tidy">CPAN</a></p></li>
  40 <li><p>The most recent release is also at <a href="https://sourceforge.net/projects/perltidy/">sourceforge</a></p></li>
  41 </ul>
  42
  43 <h2>Installation</h2>
  44
  45 <p>Perl::Tidy can be installed directly from CPAN one of the standard methods.</p>
  46
  47 <p>One way is to download a distribution file, unpack it and then
  48 test and install using the Makefile.PL:</p>
  49
  50 <pre><code>perl Makefile.PL
  51 make
  52 make test
  53 make install
  54 </code></pre>
  55
  56 <p>The <a href="./INSTALL.html">INSTALL file</a> has additional installation notes. They
  57 are mainly for older sytems but also tell how to use perltidy without doing an installation.</p>
  58
  59 <h2>Links</h2>
  60
  61 <ul>
  62 <li><a href="https://github.com/perltidy/perltidy">Perl::Tidy source code repository at GitHub</a></li>
  63 <li><a href="https://metacpan.org/pod/distribution/Code-TidyAll/bin/tidyall">tidyall</a> is a great tool for automatically running perltidy and other tools including perlcritic on a set of project files.</li>
  64 <li><a href="http://sourceforge.net/projects/tidyview">Tidyview</a> is a graphical program for tweaking your .perltidyrc configuration parameters.</li>
  65 <li><a href="https://github.com/vifo/SublimePerlTidy">A perltidy plugin for Sublime Text 2/3</a></li>
  66 </ul>
  67
  68 <h2>FEEDBACK / BUG REPORTS</h2>
  69
  70 <p>A list of current bugs and issues can be found at the CPAN site <a href="https://rt.cpan.org/Public/Dist/Display.html?Name=Perl-Tidy">https://rt.cpan.org/Public/Dist/Display.html?Name=Perl-Tidy</a></p>
  71
  72 <p>To report a new bug or problem, use the link on this page .</p>