Lua bindings for POSIX APIs
C Shell Lua Makefile
Pull request Compare This branch is 43 commits behind luaposix:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
build-aux
examples
ext
gnulib
lib posix: don't leak execx into global namespace. Oct 18, 2015
m4
slingshot
specs
.gitignore
.prev-version maint: post-release administrivia. Mar 1, 2015
.slackid
.travis.yml
.x-update-copyright
AUTHORS Mention where to look for other contributors. Apr 16, 2013
COPYING
ChangeLog.old
NEWS.md
README.md
bootstrap
bootstrap.conf
configure.ac
local.mk
luaposix-git-1.rockspec build: remove posix.bit32 Feb 19, 2015
rockspec.conf

README.md

luaposix

By the luaposix project

License travis-ci status Stories in Ready

This is a POSIX binding, including curses, for LuaJIT, Lua 5.1, 5.2 and 5.3; like most libraries it simply binds to C APIs on the underlying system, so it won't work on non-POSIX systems. However, it does try to detect the level of POSIX conformance of the underlying system and bind only available APIs.

luaposix is released under the MIT license (the same license as Lua itsef). There is no warranty.

Installation

The simplest and best way to install luaposix is with LuaRocks. To install the latest release (recommended):

    luarocks install luaposix

To install current git master (for testing, before submitting a bug report for example):

    luarocks install http://raw.github.com/luaposix/luaposix/release/luaposix-git-1.rockspec

The best way to install without LuaRocks, is to download a github release tarball and follow the instructions in the included INSTALL fill. Even if you are repackaging or redistributing luaposix, this is by far the most straight forward place to begin.

Note that you'll be responsible for providing dependencies if you choose not to let LuaRocks handle them for you, though you can find a list of the minimal dependencies in the rockspec.conf file.

It is also possible to perform a complete bootstrap of the master development branch, although this branch is unstable, and sometimes breaks subtly, or does not build at all, or provides experimental new APIs that end up being removed prior to the next official release. Unfortunately, we don't have time to provide support for taking this most difficult and dangerous option. It is presumed that you already know enough to be aware of what you are getting yourself into - however, there are full logs of complete bootstrap builds in Travis after every commit, that you can examine if you get stuck. Also, the bootstrap script tries very hard to tell you why it is unhappy and, sometimes, even how to fix things before trying again.

Use

The library is split into submodules according to the POSIX header file API declarations, which you can require individually:

    local unistd = require "posix.unistd"

The authoritative online POSIX reference is published at SUSv3.

Documentation

The latest release of this library is documented in LDoc. Pre-built HTML files are included in the release, and contain links to the appropriate SUSv3 manual pages.

Example code

See the example program tree.lua, along with the many small examples in the generated documentation and BDD specs/*_spec.yaml.

For a complete application, see the GNU Zile.

Bugs reports and code contributions

These libraries are maintained by their users.

Please make bug reports and suggestions as GitHub issues. Pull requests are especially appreciated.

But first, please check that you issue has not already been reported by someone else, and that it is not already fixed by master in preparation for the next release (See Installation section above for how to temporarily install master with LuaRocks).

There is no strict coding style, but please bear in mind the following points when proposing changes:

  1. Follow existing code. There are a lot of useful patterns and avoided traps there.

  2. 8-character indentation using TABs in C sources; 2-character indentation using SPACEs in Lua sources.

  3. No non-POSIX APIs; no platform-specific code. When wrapping APIs introduced in POSIX 2001 or later, add an appropriate #if. If your platform isn't quite POSIX, you may find a gnulib module to bridge the gap. If absolutely necessary, use autoconf feature tests.

  4. Thin wrappers: although some existing code contradicts this, wrap POSIX APIs in the simplest way possible. If necessary, more convenient wrappers can be added in Lua (posix.lua).