hr - Print horizontal bar on the terminal
This document describes version 0.25 of main (from Perl distribution App-hr), released on 2016-06-17.
Usage:
% hr [options] [pattern]
hr can be useful as a marker/separator, especially if you use other commands that might produce a lot of output, and you need to scroll back lots of pages to see previous output. Example:
hr
% hr; command-that-produces-lots-of-output ============================================================================ Command output ... ... ... % hr -r; some-command; hr -r; another-command
% hr ============================================================================ % hr -c red ;# will output the same bar, but in red % hr --random-color ;# will output the same bar, but in random color % hr x---- x----x----x----x----x----x----x----x----x----x----x----x----x----x----x----x % hr -- -x- ;# specify a pattern that starts with a dash % hr -p -x- ;# ditto % hr --random-pattern vvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvv % hr --random-pattern *---*---*---*---*---*---*---*---*---*---*---*---*---*---*---*---*---*---*--- % hr -r ;# shortcut for --random-pattern --random-color % hr --help
If you use Perl, you can also use the hr function in App::hr module.
App::hr
* marks required options.
*
Specify a color (see Term::ANSIColor).
Specify height (number of rows).
Default value:
1
Display help message and exit.
Specify a pattern.
Number of empty rows after drawing the bar.
0
Number of empty rows before drawing the bar.
Display program's version and exit.
Alias for --random-pattern --random-color.
See --random-pattern.
--random-pattern
The distribution comes with a shell completer script (_hr) for this script.
To activate bash completion for this script, put:
complete -C _hr hr
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.
~/.bashrc
It is recommended, however, that you install shcompgen which allows you to activate completion scripts for several kinds of scripts on multiple shells. Some CPAN distributions (those that are built with Dist::Zilla::Plugin::GenShellCompletion) will even automatically enable shell completion for their included scripts (using shcompgen) at installation time, so you can immadiately have tab completion.
shcompgen
To activate tcsh completion for this script, put:
complete _hr 'p/*/`hr`/'
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.
~/.tcshrc
It is also recommended to install shcompgen (see above).
For fish and zsh, install shcompgen as described above.
Please visit the project's homepage at https://metacpan.org/release/App-hr.
Source repository is at https://github.com/perlancar/perl-App-hr.
Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=App-hr
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.
perlancar <perlancar@cpan.org>
This software is copyright (c) 2016 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.
To install App::hr, copy and paste the appropriate command in to your terminal.
cpanm
cpanm App::hr
CPAN shell
perl -MCPAN -e shell install App::hr
For more information on module installation, please visit the detailed CPAN module installation guide.