horizontal-rule: horizontal rule for the terminal
This package provides a utility for displaying a horizontal rule in a terminal. Please see the README on GitHub at https://github.com/ExtremaIS/hr-haskell#readme.
[Skip to Readme]
Flags
Automatic Flags
| Name | Description | Default |
|---|---|---|
| optparse-applicative_ge_0_18 | Use optparse-applicative 0.18 or newer | Disabled |
Use -f <flag> to enable a flag, or -f -<flag> to disable that flag. More info
Downloads
- horizontal-rule-0.6.0.0.tar.gz [browse] (Cabal source package)
- Package description (revised from the package)
Note: This package has metadata revisions in the cabal description newer than included in the tarball. To unpack the package including the revisions, use 'cabal get'.
Maintainer's Corner
For package maintainers and hackage trustees
Candidates
- No Candidates
| Versions [RSS] | 0.5.0.0, 0.6.0.0 |
|---|---|
| Change log | CHANGELOG.md |
| Dependencies | ansi-wl-pprint (>=0.6.8 && <1.1), base (>=4.10.1 && <4.20), horizontal-rule, optparse-applicative (>=0.13 && <0.19), prettyprinter (>=1.7.1 && <1.8), terminal-size (>=0.2 && <0.4), text (>=1.2.3 && <2.2), time (>=1.8.0.2 && <1.15) [details] |
| License | MIT |
| Copyright | Copyright (c) 2019-2023 Travis Cardwell |
| Author | Travis Cardwell <travis.cardwell@extrema.is> |
| Maintainer | Travis Cardwell <travis.cardwell@extrema.is> |
| Revised | Revision 4 made by TravisCardwell at 2024-04-16T21:38:12Z |
| Category | Utils |
| Home page | https://github.com/ExtremaIS/hr-haskell#readme |
| Bug tracker | https://github.com/ExtremaIS/hr-haskell/issues |
| Source repo | head: git clone https://github.com/ExtremaIS/hr-haskell.git |
| Uploaded | by TravisCardwell at 2023-05-27T21:04:52Z |
| Distributions | LTSHaskell:0.6.0.0, NixOS:0.6.0.0, Stackage:0.6.0.0 |
| Executables | hr |
| Downloads | 259 total (13 in the last 30 days) |
| Rating | (no votes yet) [estimated by Bayesian average] |
| Your Rating | |
| Status | Docs uploaded by user Build status unknown [no reports yet] |
Readme for horizontal-rule-0.6.0.0
[back to package description]hr
Overview
hr is a utility for displaying a horizontal rule in a terminal.
It is useful for marking a position in your terminal so that you can easily
find it again. For example, use hr to display a horizontal rule before each
build of a project so that you can easily find the beginning of the output of
the last build.
CLI
Requirements
hr has only been tested on Linux. It might work on Windows and macOS.
Installation
.deb Package Installation
Check the Releases page for .deb packages.
.rpm Package Installation
Check the Releases page for .rpm packages.
Installation From Hackage
Install hr from Hackage using Cabal as follows:
$ cabal v2-install horizontal-rule
Installation From Stackage
Install hr from Stackage using Stack as follows:
$ stack install horizontal-rule
Usage
See the hr man page for usage information.
Examples
The rule fills with width of the terminal by default:
$ hr
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
In cases when the terminal width cannot be determined, a default width is used. This default width can be set with an option:
$ hr -d 78
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
If desired, the rule width can be specified:
$ hr -w 60
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
In cases where the terminal cannot display Unicode, ASCII may be used:
$ hr -a
------------------------------------------------------------------------------
The rule can include the current time:
$ hr -t
━━┫2021-05-27 19:26:09┣━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
The time format can be specified:
$ hr -t -f "%H:%M:%S.%q"
━━┫19:30:44.861779179000┣━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
The first line read from STDIN can be used as a note:
$ uname -m | hr -i
━━┫x86_64┣━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
When input is read, a timeout is used to ensure that hr does not "hang" when
there is no input. The timeout (in milliseconds) can be specified:
$ uname -m | hr -i --timeout 100
━━┫x86_64┣━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
A note can be specified as one or more arguments:
$ hr unit tests
━━┫unit tests┣━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
Different types of notes can be combined:
$ uname -m | hr -it unit tests
━━┫2021-05-27 19:48:48┣━┫unit tests┣━┫x86_64┣━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
Library
You can easily include horizontal rules in the output of your own Haskell
software by using the library. The Haskell package is named horizontal-rule
in Hackage and Stackage because there is an existing package named
hR.
Project
Links
- Hackage: https://hackage.haskell.org/package/horizontal-rule
- Stackage: https://www.stackage.org/package/horizontal-rule
- Flora: https://flora.pm/packages/@hackage/horizontal-rule
- GitHub: https://github.com/ExtremaIS/hr-haskell
- GitHub Actions CI: https://github.com/ExtremaIS/hr-haskell/actions
Branches
The main branch is reserved for releases. It may be considered stable, and
HEAD is always the latest release.
The develop branch is the primary development branch. It contains changes
that have not yet been released, and it is not necessarily stable.
Hackage revisions are made for metadata changes, such as relaxation of
constraints when new versions of dependencies are released. The
horizontal-rule.cabal metadata in the main branch may therefore not match
that of Hackage. The horizontal-rule.cabal metadata in the develop branch
may match, unless work is being done on a new release that contains other
changes.
Tags
All releases are tagged in the main branch. Release tags are signed using
the security@extrema.is GPG key.
Contribution
Issues and feature requests are tracked on GitHub: https://github.com/ExtremaIS/hr-haskell/issues
Issues may also be submitted via email to bugs@extrema.is.
License
This project is released under the MIT License as specified in the
LICENSE file.