diff options
| author | Jason Evans <jasone@canonware.com> | 2010-11-25 06:00:02 (GMT) |
|---|---|---|
| committer | Jason Evans <jasone@canonware.com> | 2010-11-27 03:32:22 (GMT) |
| commit | aee7fd2b70050fb434f2c9f52153194de73dc051 (patch) | |
| tree | fd7307d70393a46afc1a248da39ebc31b6cedb9a /jemalloc/INSTALL | |
| parent | fc4dcfa2f546354dd536a3a33aa9f10fd3253731 (diff) | |
| download | jemalloc-aee7fd2b70050fb434f2c9f52153194de73dc051.zip jemalloc-aee7fd2b70050fb434f2c9f52153194de73dc051.tar.gz jemalloc-aee7fd2b70050fb434f2c9f52153194de73dc051.tar.bz2 | |
Convert man page from roff to DocBook.
Convert the man page source from roff to DocBook, and generate html and
roff output. Modify the build system such that the documentation can be
built as part of the release process, so that users need not have
DocBook tools installed.
Diffstat (limited to 'jemalloc/INSTALL')
| -rw-r--r-- | jemalloc/INSTALL | 16 |
1 files changed, 10 insertions, 6 deletions
diff --git a/jemalloc/INSTALL b/jemalloc/INSTALL index fafd788..b77ebfd 100644 --- a/jemalloc/INSTALL +++ b/jemalloc/INSTALL @@ -132,8 +132,11 @@ any of the following arguments (not a definitive list) to 'configure': --disable-tls Disable thread-local storage (TLS), which allows for fast access to thread-local variables via the __thread keyword. If TLS is available, - jemalloc uses it for several purposes. Note that disabling TLS implies - --disable-tcache. + jemalloc uses it for several purposes. + +--with-xslroot=<path> + Specify where to find DocBook XSL stylesheets when building the + documentation. The following environment variables (not a definitive list) impact configure's behavior: @@ -172,7 +175,7 @@ To install only parts of jemalloc, use the following targets: install_bin install_include install_lib - install_man + install_doc To clean up build results to varying degrees, use the following make targets: @@ -232,11 +235,12 @@ directory, issue configuration and build commands: === Documentation ============================================================== -The manual page that the configure script generates can be manually formatted +The manual page is generated in both html and roff formats. Any web browser +can be used to view the html manual. The roff manual page can be formatted prior to installation via any of the following commands: - nroff -man -man-ext -t doc/jemalloc.3 + nroff -man -t doc/jemalloc.3 - groff -man -man-ext -t -Tps doc/jemalloc.3 | ps2pdf - doc/jemalloc.3.pdf + groff -man -t -Tps doc/jemalloc.3 | ps2pdf - doc/jemalloc.3.pdf (cd doc; groff -man -man-ext -t -Thtml jemalloc.3 > jemalloc.3.html) |