1
0
mirror of https://github.com/stedolan/jq.git synced 2024-05-11 05:55:39 +00:00
Nicolas Williams ae7f8d6ab9 Further module system revamp (fix #659)
To import a module now use:

    # Import module.jq file:
    import "relative/path/to/module" as foo;

    # Use the module's defs as foo::<def-name>

To import a JSON file:

    # Read file.json:
    import "relative/path/to/file" as $foo;
    #
    # Use as $foo::foo

Using `-L` now drops the builtin library path and appends the requested
path to the empty array (or the result of an earlier `-L`).

Support for the `$JQ_LIBRARY_PATH` environment variable has been
removed.
2014-12-31 20:09:53 -06:00
..
2014-06-04 18:36:30 -05:00
2014-06-16 13:25:50 -05:00

Documentation

The jq website, manpages and some of the tests are generated from this directory. The directory holds a Bonsai website, and the manual is a YAML file in content/3.manual.

To build the documentation (including building the jq manpage), you'll need a working Ruby setup. The easiest way to get one is to install RVM and Ruby 1.9.3 like so:

\curl -L https://get.rvm.io | bash -s stable --ruby=1.9.3

After that finishes installing, you'll need to make sure RVM is on your path by doing source $HOME/.rvm/scripts/rvm, or just opening a new shell. See http://rvm.io for more info on RVM.

Once RVM is installed, you can install all the dependencies for jq's documentation build by running this from the docs directory:

bundle install

When bundle manages to install the dependencies, rerun ./configure in the jq root directory and then the Makefile will be able to generate the jq manpage.