NAME

bloomchk - Shorter alias for check-with-bloom-filter

VERSION

This document describes version 0.007 of bloomchk (from Perl distribution App-BloomUtils), released on 2020-05-24.

SYNOPSIS

Usage:

% bloomchk [--debug] [--log-level=level] [--page-result[=program]]
    [--quiet] [--trace] [--verbose] <items> ...

DESCRIPTION

You supply the bloom filter in STDIN, items to check as arguments, and this utility will print lines containing 0 or 1 depending on whether items in the arguments are tested to be, respectively, not in the set (0) or probably in the set (1).

OPTIONS

* marks required options.

Main options

--items-json=s

Items to check (JSON-encoded).

See --items.

--items=s@*

Items to check.

Can be specified multiple times.

Logging options

--debug

Shortcut for --log-level=debug.

--log-level=s

Set log level.

--quiet

Shortcut for --log-level=error.

--trace

Shortcut for --log-level=trace.

--verbose

Shortcut for --log-level=info.

Output options

--page-result

Filter output through a pager.

Other options

--help, -h, -?

Display help message and exit.

--version, -v

Display program's version and exit.

COMPLETION

This script has shell tab completion capability with support for several shells.

bash

To activate bash completion for this script, put:

complete -C bloomchk bloomchk

in your bash startup (e.g. ~/.bashrc). Your next shell session will then recognize tab completion for the command. Or, you can also directly execute the line above in your shell to activate immediately.

It is recommended, however, that you install modules using cpanm-shcompgen which can activate shell completion for scripts immediately.

tcsh

To activate tcsh completion for this script, put:

complete bloomchk 'p/*/`bloomchk`/'

in your tcsh startup (e.g. ~/.tcshrc). Your next shell session will then recognize tab completion for the command. Or, you can also directly execute the line above in your shell to activate immediately.

It is also recommended to install shcompgen (see above).

other shells

For fish and zsh, install shcompgen as described above.

HOMEPAGE

Please visit the project's homepage at https://metacpan.org/release/App-BloomUtils.

SOURCE

Source repository is at https://github.com/perlancar/perl-App-BloomUtils.

BUGS

Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=App-BloomUtils

When submitting a bug or request, please include a test-file or a patch to an existing test-file that illustrates the bug or desired feature.

AUTHOR

perlancar <perlancar@cpan.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2020, 2018 by perlancar@cpan.org.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.

cpanm App::BloomUtils

perl -MCPAN -e shell
install App::BloomUtils