about summary refs log tree commit homepage
= wordexp - perform word expansion like a POSIX shell

This is a trivial C extension which allows access to the wordexp(3)
POSIX function.  See the wordexp(3) manpage for details.

For implementations with a GVL (Global VM Lock), this releases the GVL
when using command expansion.  Long-running commands do not freeze
the entire VM.

Compared to the Shellwords.split method in the Ruby standard library,
wordexp is also capable of shell string operations in POSIX shell
syntax, (environment) variable substitution, tilde path expansion,
command substition ($(command) or `command`), arithmetic expansion,
wildcard expansion, and respects the IFS environment variable.

Requirements
------------

* a Free, Unix-like operating system with the wordexp(3) POSIX function

* a C compiler and standard development environment

* Ruby 1.9.3 or later (any Ruby implementation compatible with C extensions)

Usage
-----

Online:
	http://bogomips.org/ruby-wordexp/api.txt

Or once installed:

	ri Wordexp
	ri Wordexp#wordexp

Install
-------

Installation is easy using RubyGems:

	gem install wordexp

If you do not use RubyGems, you may also install from the tarball:

	wget http://bogomips.org/ruby-wordexp/files/wordexp-1.0.0.tgz
	tar zxvf wordexp-1.0.0.tgz
	cd wordexp-1.0.0
	ruby setup.rb

Source
------

	git clone git://bogomips.org/ruby-wordexp.git

Also viewable with a browser via cgit or gitweb:

	http://bogomips.org/ruby-wordexp.git

It is also mirrored on repo.or.cz

	git clone git://repo.or.cz/ruby-wordexp.git

And viewable with gitweb:

	http://repo.or.cz/w/ruby-wordexp.git

Contact
-------

Bug reports, user/development discussion, patches, pull requests are
greatly appreciated via plain-text email.

Please use "git format-patch -M" to format your patches and "git
send-email" to send patches.

Pull requests should be formatted using the "git request-pull" command.

The public mailing list is at: ruby-wordexp-public@bogomips.org

Archives are available at: http://bogomips.org/ruby-wordexp-public/

If you have an issue you wish to keep private, feel free to contact
Eric Wong directly at: bofh@bogomips.org

HTML email will be mercilessly deleted.

Links
-----
homepage - http://bogomips.org/ruby-wordexp/README
Atom feed - http://bogomips.org/ruby-wordexp/NEWS.atom.xml

License
-------
Ruby wordexp is copyrighted Free Software by all contributors, see logs
in revision control for names and email addresses of all of them.

You can redistribute Ruby wordexp and/or modify it under the terms of
the GNU Lesser General Public License, version 2.1 or later as published
by the Free Software Foundation.

Ruby wordexp is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser
General Public License for more details.

You should have received a copy of the GNU Lesser General Public License
along with Ruby wordexp; if not, see https://www.gnu.org/licenses/lgpl-2.1.txt
or https://www.gnu.org/licenses/lgpl-3.0.txt