package pageantty
Install
dune-project
Dependency
Authors
Maintainers
Sources
sha256=6b32385d8f487a3f9a63aeb37f49924c826a8a47e5ec370ee8b0011a41ca3acd
sha512=c242703ab3be71615156cf4cde13c6b4b07d01742d0bbb178059138ba4819c8d0a474c9d31db8521dae821aafe9f24ffc375872e7f30cd1de72a36f1441a4c19
Description
[pageantty] provides utility libraries for running pagers in the terminal.
It includes [Git_pager], a small one-module library for displaying Git diffs and other custom outputs in a terminal pager.
This is useful for tools that integrate with Git and need to display output exceeding one screen, while respecting user color preferences and Git's configuration.
README
git-pager
Welcome to git-pager, a small one-module OCaml library for running a Git pager to display diffs and other custom outputs in the terminal.
It is particularly useful for tools that integrate with Git and need to display output exceeding one screen, while respecting user color preferences and Git's configuration.
Hello Pager
Here is a short example using the Git_pager. It will run a pager according to your git config, and allows you to access an Out_channel.t where you can write the output to:
let () =
Git_pager.run ~f:(fun pager ->
let write_end = Git_pager.write_end pager in
Printf.fprintf write_end "Hello, pager!\n")
;;Published named
To publish this project to opam we're using a packaging naming scheme where pageantty is a namespacing prefix.
pageantty (pronounced: "pageant-T-Y", like "pageant" + the letters "T" and "Y", IPA: /ˈpædʒənt ti waɪ/).
The current Git_pager module is available as the main library of the pageantty.git-pager sub-package.
Dependencies (5)
-
pplumbing-pp-tty
>= "0.0.16" -
pplumbing-err
>= "0.0.16" -
pp
>= "2.0.0" -
ocaml
>= "4.14" -
dune
>= "3.17"
Dev Dependencies (1)
-
odoc
with-doc
Conflicts
None