Andrew O'Brien
943090846f
When running `make` I ran into a couple of problems building the manual. While I'm not entirely sure that this is the root cause, it appears to have been related to the fact that ruby 2.0 dropped syck completely in favor of psych (which was introduced in 1.9.2) for YAML processing. I'm currently using ruby 2.1.0p0. I'm assuming that the fact that the YAML engine was explicitly set to syck in the Rakefile was an attempt to work around some incompatibility between the two libraries, so I looked into what would be necessary to get it to work with the newer one. The changes to `manual.yml` ended up being pretty minor: I ran it through `iconv` to convert some ISO-8859-1 characters to UTF-8 and added some quotes in places (apparently you can't start a string value with '`').
jq
jq is a command-line JSON processor.
If you want to learn to use jq, read the documentation at http://stedolan.github.io/jq. This documentation is generated from the docs/ folder of this repository. You can also try it online at jqplay.org.
If you want to hack on jq, feel free, but be warned that its internals are not well-documented at the moment. Bring a hard hat and a shovel. Also, read the wiki: http://github.com/stedolan/jq/wiki
Source tarball and built executable releases can be found on the homepage and on the github release page, https://github.com/stedolan/jq/releases
If you're building directly from the latest git, you'll need flex, bison (3.0 or newer), libtool, make, and autoconf installed. To get regexp support you'll also need to install Oniguruma (note that jq's tests require regexp support to pass). To build, run:
autoreconf -i # if building from git
./configure
make -j8
make check
To build without bison or flex, add --disable-maintainer-mode to the
./configure invocation:
./configure --disable-maintainer-mode
(Developers must not use --disable-maintainer-mode, not when making
changes to the jq parser and/or lexer.)
To build a statically linked version of jq, run:
make LDFLAGS=-all-static
After make finishes, you'll be able to use ./jq. You can also
install it using:
sudo make install
If you're not using the latest git version but instead building a
released tarball (available on the website), then you won't need to
run autoreconf (and shouldn't), and you won't need flex or bison.
To cross-compile for OS X and Windows, see docs/Rakefile's build task and scripts/crosscompile. You'll need a cross-compilation environment, such as Mingw for cross-compiling for Windows.
Cross-compilation requires a clean workspace, then:
# git clean ...
autoreconf -i
./configure
make distclean
scripts/crosscompile <name-of-build> <configure-options>
Use the --host= and --target= ./configure options to select a cross-compilation environment. See also the wiki.