Changeset 4537

Timestamp:

06/11/05 15:58:18 (4 years ago)

Author:

iblech

svk:copy_cache_prev:

6289

Message:

Pugs.Help -- Minor cosmetic fix.
pugs::run -- Wrote section about Pugs' command line flags.

Files:

• lib/pugs/run.pod (modified) (3 diffs)
• src/Pugs/Help.hs (modified) (1 diff)

lib/pugs/run.pod

@@ -1 +1 @@
 =head1 NAME
 
-pugs::run - how to execute the Pugs interpreter
+pugs::run - How to execute Pugs
 
 =head1 SYNOPSYS
@@ -10 +10 @@
      S<[ B<-C>I<backend> [I<file>] ]>
      S<[ B<-B>I<backend> [I<file>] ]>
+     S<[ B<-M>I<module> ]>
      S<[ B<--external> [I<file>] ] >
      S<[ B<-e> I<program> ]>
@@ -23 +24 @@
 WRITEME
 
-=head2 Command Switches
+=head2 Command line options
 
-WRITEME
+You can pass various command line options to Pugs.
+
+=over
+
+=item C<-e I<program>>
+
+causes Pugs to not look for any program files in the command line options, but
+instead run the one-line program specified. Multiple C<-e> commands work too.
+
+=item C<-n>
+
+causes Pugs to assume the following loop around your program, which makes it
+iterate over filename arguments somewhat like sed -n or awk:
+
+    while =<> {
+        ...your program here...
+    }
+
+=item C<-p>
+
+causes Pugs to assume the following loop around your program, which makes it
+iterate over filename arguments somewhat like sed:
+
+    while =<> {
+        ...your program here...
+        say;
+    }
+
+=item C<-c>
+
+causes Pugs to not run the program, but merely check its syntax.
+
+Note that C<BEGIN {...}> and C<CHECK {...}> blocks, as well as C<use Module>,
+are still executed, because these might change the grammar or create new
+operators, etc. So the following is B<not> safe:
+
+    pugs -c 'BEGIN { system "evil command" }'
+
+If you want to run a potentially unsafe program safely, see the safemode Pugs
+provides.
+
+=item C<-BI<backend>>
+
+causes Pugs to execute the program using C<I<backend>>. Currently, valid
+backends are C<Pugs>, C<Parrot>, and C<Haskell>.
+
+=item C<-CI<backend>>
+
+causes Pugs to compile the program using C<I<backend>>. Currently, valid
+backends are C<Pugs>, C<Parrot>, and C<Haskell>.
+
+Note that, as with C<-c>, C<BEGIN {...}> and C<CHECK {...}> blocks, as well as
+C<use Module>, are still executed. So don't try to compile potentially unsafe
+code!
+
+=item C<-MI<module>>
+
+causes Pugs to load C<I<module>> before executing your program:
+
+    use module;
+    ...your code here...
+
+=item C<-h> or C<--help>
+
+outputs a short summary of the available command line options. No programs are
+executed.
+
+=item C<-V>
+
+outputs the version of Pugs you're running and long configuration information.
+
+=item C<-V:I<item>>
+
+outputs short configuration information for C<I<item>>.
+
+    $ pugs -V:pugs_version
+    pugs_versnum: 6.2.6
+
+=item C<-v> or C<--version>
+
+outputs the version of Pugs you're running.
+
+=item C<-l>, C<-d>, and C<-w>
+
+are ignored for compatibility with Perl 5.
+
+=back
 
 =head1 ENVIRONMENT
 
-The pugs runtime environment is affected by several environment variables.
+The Pugs runtime environment is affected by several environment variables.
 
 The build environment is likewise controlled by several environment variables;
-since pugs is still in heavy development, they will be listed here as well.
+since Pugs is still in heavy development, they will be listed here as well.
 
 =over

src/Pugs/Help.hs

@@ -44 +44 @@
         putStrLn "-Cbackend        compile using the compiler backend"
         putStrLn "                 (valid backends are: Pugs, Parrot, Haskell)"
-        putStrLn "-M module        execute 'use module' before executing the program"
+        putStrLn "-Mmodule         execute 'use module' before executing the program"
         putStrLn "-h or --help     give this message"
         putStrLn "-V               long configuration information & version"