]> Sergey Matveev's repositories - public-inbox.git/commitdiff
watch: add --help/-h support
authorEric Wong <e@80x24.org>
Tue, 1 Sep 2020 01:15:05 +0000 (01:15 +0000)
committerEric Wong <e@80x24.org>
Wed, 2 Sep 2020 08:53:59 +0000 (08:53 +0000)
And avoid unnecessary POD markup in the man page.

Documentation/public-inbox-watch.pod
script/public-inbox-watch

index f3e622b050793946f24d67976fcd7c3c80249208..73340ec486f4accb2ac79457ea2b2fd9efa4e4c2 100644 (file)
@@ -4,7 +4,7 @@ public-inbox-watch - mailbox watcher for public-inbox
 
 =head1 SYNOPSIS
 
-B<public-inbox-watch>
+       public-inbox-watch
 
 In ~/.public-inbox/config:
 
index b6c6b2022bb7ae64e6aae5e4cccaa73b68866e59..1d164aa39ab2df0b77c765ec60378ad087a0d8d8 100755 (executable)
@@ -1,13 +1,24 @@
 #!/usr/bin/perl -w
 # Copyright (C) 2016-2020 all contributors <meta@public-inbox.org>
 # License: AGPL-3.0+ <https://www.gnu.org/licenses/agpl-3.0.txt>
+my $help = <<EOF;
+usage: public-inbox-watch
+
+See public-inbox-watch(1) man page for full documentation.
+EOF
+
 use strict;
-use IO::Handle;
+use Getopt::Long qw(:config gnu_getopt no_ignore_case auto_abbrev);
+use IO::Handle; # ->autoflush
 use PublicInbox::Watch;
 use PublicInbox::Config;
 use PublicInbox::DS;
 use PublicInbox::Sigfd;
 use PublicInbox::Syscall qw($SFD_NONBLOCK);
+my $do_scan = 1;
+GetOptions('scan!' => \$do_scan, # undocumented, testing only
+       'help|h' => \(my $show_help)) or do { print STDERR $help; exit 1 };
+if ($show_help) { print $help; exit 0 };
 my $oldset = PublicInbox::Sigfd::block_signals();
 STDOUT->autoflush(1);
 STDERR->autoflush(1);
@@ -44,9 +55,8 @@ if ($watch) {
        $sig->{QUIT} = $sig->{TERM} = $sig->{INT} = $quit;
 
        # --no-scan is only intended for testing atm, undocumented.
-       unless (grep(/\A--no-scan\z/, @ARGV)) {
-               PublicInbox::DS::requeue($scan);
-       }
+       PublicInbox::DS::requeue($scan) if $do_scan;
+
        my $sigfd = PublicInbox::Sigfd->new($sig, $SFD_NONBLOCK);
        local %SIG = (%SIG, %$sig) if !$sigfd;
        if (!$sigfd) {