]> git.donarmstrong.com Git - perltidy.git/commitdiff
update man page
authorSteve Hancock <perltidy@users.sourceforge.net>
Sun, 5 Feb 2023 01:32:27 +0000 (17:32 -0800)
committerSteve Hancock <perltidy@users.sourceforge.net>
Sun, 5 Feb 2023 01:32:27 +0000 (17:32 -0800)
bin/perltidy

index b6fe87065a049502d9c24276ea2a65bee7cce383..84e05fdf11d110dcc32c74cc3002cd45e3dabc83 100755 (executable)
@@ -35,8 +35,12 @@ perltidy - a perl script indenter and reformatter
 
 =head1 DESCRIPTION
 
-Perltidy reads a perl script and writes an indented, reformatted script.
-This document describes the parameters available for controlling this formatting.
+Perltidy reads a perl script and writes an indented, reformatted script.  The
+formatting process involves converting the script into a string of tokens,
+removing any non-essential whitespace, and then rewriting the string of tokens
+with whitespace using whatever rules are specified, or defaults.  This happens
+in a series of operations which can be controlled with the parameters described
+in this document.
 
 Perltidy is a commandline frontend to the module Perl::Tidy.  For documentation
 describing how to call the Perl::Tidy module from other applications see the