luaman

A command-line Lua manual browser

luaman allows you to browse the Lua reference manuals from the command-line. It's a script that uses man to display a Lua reference manual in the terminal.

luaman automatically jumps to the function you specify. For example, if you run this:

luaman print

luaman will open the manual pager (man) and jump to your specified function.

print (···)
 Receives any number of arguments and prints their values to stdout, converting each argument to a string following the same
 rules of tostring.
 The function print is not intended for formatted output, but only as a quick way to show a value, for instance for debug‐
 ging. For complete control over the output, use string.format and io.write.

Installation

Dependencies

First, make sure you have luarocks installed.

Install the http module, luaman's only dependency:

$ luarocks install http --local

Now clone the repository, then run make install:

$ git clone https://codeberg.org/jtbx/luaman
$ cd luaman
# make install

The manual pages are downloaded in Roff format from my Codeberg Pages site. They are converted from HTML to Roff using Pandoc.

Manual pages are cached to ~/.local/share/luaman.