NAME

wordstat - Return word statistics of a text

VERSION

This document describes version 0.003 of wordstat (from Perl distribution App-wordstat), released on 2020-10-11.

SYNOPSIS

Usage:

 % wordstat [--format=name] [--json] [--(no)naked-res]
     [--page-result[=program]] [--view-result[=program]] <text>

Examples:

 % wordstat 'An optimistic person sees good things everywhere, is generally confident and
hopeful of what the future holds. From the optimist'\''s point-of-view the world is
full of potential opportunities. The pessimist, on the other hand, observes
mainly the negative aspects of everything around.

' +-------------------------------+------------------+ | key | value | +-------------------------------+------------------+ | avg_line_len | 56 | | avg_line_with_words_len | 70 | | avg_nonempty_line_len | 70 | | avg_word_len | 5.17777777777778 | | avg_words_per_line | 9 | | avg_words_per_line_with_words | 11.25 | | avg_words_per_nonempty_line | 11.25 | | longest_word_len | 13 | | num_chars | 285 | | num_lines | 5 | | num_lines_with_words | 4 | | num_nonempty_lines | 4 | | num_unique_words | 36 | | num_words | 45 | | shortest_word_len | 1 | +-------------------------------+------------------+

Supply text from file or stdin:

 % wordstat file.txt

OPTIONS

* marks required options.

Main options

--text=s*

Output options

--format=s

Choose output format, e.g. json, text.

Default value:

 undef
--json

Set output format to json.

--naked-res

When outputing as JSON, strip result envelope.

Default value:

 0

By default, when outputing as JSON, the full enveloped result is returned, e.g.:

    [200,"OK",[1,2,3],{"func.extra"=>4}]

The reason is so you can get the status (1st element), status message (2nd element) as well as result metadata/extra result (4th element) instead of just the result (3rd element). However, sometimes you want just the result, e.g. when you want to pipe the result for more post-processing. In this case you can use `--naked-res` so you just get:

    [1,2,3]
--page-result

Filter output through a pager.

--view-result

View output using a viewer.

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 wordstat wordstat

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 wordstat 'p/*/`wordstat`/'

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-wordstat.

SOURCE

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

BUGS

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

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 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.