1 files changed, 79 insertions, 5 deletions
diff --git a/script/mwrap-rproxy b/script/mwrap-rproxy
index 97cca8e..da5379a 100644
--- a/script/mwrap-rproxy
+++ b/script/mwrap-rproxy
@@ -4,14 +4,17 @@
  # thin wrapper for Devel::Mwrap::Rproxy
  use v5.12; # strict
  eval { require Plack::Runner } or die "Plack not installed: $@\n";
-require Devel::Mwrap::Rproxy;
  use Getopt::Long qw(:config no_ignore_case no_auto_abbrev pass_through);
  my $usage = "$0 --socket-dir=/path/to/socket-dir [PLACKUP_OPTIONS]\n";
-my $socket_dir;
-my $gz = 1;
-GetOptions('socket-dir=s' => \$socket_dir, 'deflate!' => \$gz) or die $usage;
+my %opt = (deflate => 1);
+GetOptions(\%opt, 'socket-dir=s', 'deflate!', 'help|h') or do {
+        require Pod::Usage; Pod::Usage::pod2usage(1);
+};
+if ($opt{help}) { require Pod::Usage; Pod::Usage::pod2usage(0) }
+my $socket_dir = delete $opt{'socket-dir'};
  $socket_dir //= ($ENV{MWRAP} // '') =~ m!\bsocket_dir:([^,]+)! ? $1 : undef;
  $socket_dir // die $usage;
+require Devel::Mwrap::Rproxy;
  my $rproxy = Devel::Mwrap::Rproxy->new($socket_dir);
  my $app = sub { $rproxy->call(@_) };
  my $runner = Plack::Runner->new;
@@ -28,7 +31,78 @@ Inherited socket (fd=3) is non-blocking, making it blocking.
                  $runner->set_options(listen_sock => $s);
          }
  }
-if ($gz && eval { require Plack::Middleware::Deflater } and !$@) {
+if ($opt{deflate} && eval { require Plack::Middleware::Deflater } and !$@) {
          $app = Plack::Middleware::Deflater->wrap($app);
  }
  $runner->run($app);
+__END__
+=head1 NAME
+
+mwrap-rproxy - reverse proxy for embedded per-process mwrap httpd
+
+=head1 SYNOPSIS
+
+  # start the long-running COMMAND you wish to trace:
+  MWRAP=socket_dir:$DIRECTORY mwrap-perl COMMAND
+
+  # in a different terminal, point mwrap-proxy to the mwrap-perl socket_dir
+  mwrap-rproxy --socket-dir=$DIRECTORY -l 127.0.0.1:8080
+
+  # open http://127.0.0.1:8080/ in your favorite web browser:
+  w3m http://127.0.0.1:8080/
+
+=head1 DESCRIPTION
+
+B<mwrap-rproxy> is a PSGI reverse proxy to provide access
+via TCP to the native, Unix-socket-only httpd embedded inside
+mwrap core.  It provides a listing of process IDs of each process
+traced via mwrap.
+
+B<mwrap-rproxy> does not have a hard dependency on mwrap-perl itself,
+it exists to provide a convenient interface to programs being
+traced by mwrap-perl.
+
+=head1 OPTIONS
+
+=over 4
+
+=item --socket-dir=DIRECTORY
+
+If unset, it will attempt to parse C<socket_dir:> from the C<MWRAP>
+environment (see L<mwrap-perl(1p)>).
+
+=item --no-deflate
+
+L<Plack::Middleware::Deflater(3pm)> is loaded by default if available.
+Using C<--no-deflate> will save CPU cycles at the expe
+
+=back
+
+Additionally, all options in L<plackup(1p)> are supported.  Notably,
+C<-l>/C<--listen> and C<--path=/prefix> may be useful.
+
+=head1 ENVIRONMENT
+
+mwrap-rproxy supports systemd (and compatible) socket activation via
+C<LISTEN_PID> and C<LISTEN_FDS> variables.  See L<systemd.socket(5)>
+and L<sd_listen_fds(3)>.
+
+=head1 CONTACT
+
+Feedback welcome via plain-text mail to L<mailto:mwrap-perl@80x24.org>
+
+Mail archives are hosted at L<https://80x24.org/mwrap-perl/>
+
+=head1 COPYRIGHT
+
+Copyright all contributors L<mailto:mwrap-perl@80x24.org>
+
+License: GPL-2.0+ L<https://www.gnu.org/licenses/gpl-2.0.txt>
+
+Source code is at L<https://80x24.org/mwrap-perl.git/>
+
+=head1 SEE ALSO
+
+L<mwrap-perl(1p)>
+
+=cut