From 27a8039d21fc6ebeba57f666bd8806f3ce51cd85 Mon Sep 17 00:00:00 2001 From: Jack Lloyd Date: Thu, 18 Jan 2018 16:44:23 -0500 Subject: Document --with-boost option Fixes GH #1419 --- doc/manual/building.rst | 28 +++++++++++++++------------- doc/manual/cli.rst | 4 ++-- 2 files changed, 17 insertions(+), 15 deletions(-) (limited to 'doc') diff --git a/doc/manual/building.rst b/doc/manual/building.rst index f7870c865..6da09c214 100644 --- a/doc/manual/building.rst +++ b/doc/manual/building.rst @@ -299,24 +299,26 @@ Currently ``configure.py`` cannot detect if external libraries are available, so using them is controlled explicitly at build time by the user using - - ``--with-bzip2`` enables the filters providing bzip2 compression - and decompression. Requires the bzip2 development libraries to be - installed. + - ``--with-bzip2`` enables the filters providing bzip2 compression and + decompression. Requires the bzip2 development libraries to be installed. - - ``--with-zlib`` enables the filters providing zlib compression - and decompression. Requires the zlib development libraries to be - installed. + - ``--with-zlib`` enables the filters providing zlib compression and + decompression. Requires the zlib development libraries to be installed. - ``--with-lzma`` enables the filters providing lzma compression and - decompression. Requires the lzma development libraries to be - installed. + decompression. Requires the lzma development libraries to be installed. - - ``--with-sqlite3`` enables storing TLS session information to an - encrypted SQLite database. + - ``--with-sqlite3`` enables using sqlite3 databases in various contexts + (TLS session cache, PSK database, etc). - - ``--with-openssl`` adds an engine that uses OpenSSL for some public - key operations and ciphers/hashes. OpenSSL 1.0.1 or later is supported. - LibreSSL is API compatible with OpenSSL 1.0 and can be used instead. + - ``--with-openssl`` adds an engine that uses OpenSSL for some ciphers, hashes, + and public key operations. OpenSSL 1.0.2 or later is supported. LibreSSL can + also be used. + + - ``--with-boost`` enables using some Boost libraries. In particular + Boost.Filesystem is used for a few operations (but on most platforms, a + native API equivalent is available), and Boost.Asio is used to provide a few + extra TLS related command line utilities. Multiple Builds ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ diff --git a/doc/manual/cli.rst b/doc/manual/cli.rst index 7427feb5d..69b6d454e 100644 --- a/doc/manual/cli.rst +++ b/doc/manual/cli.rst @@ -163,12 +163,12 @@ TLS Server/Client defined in the *policy* file. ``tls_http_server cert key --port=443 --policy= --session-db --session-db-pass=`` - Only available if asio support was enabled. Provides a simple HTTP server + Only available if Boost.Asio support was enabled. Provides a simple HTTP server which replies to all requests with an informational text output. The server honors the TLS policy defined in the *policy* file. ``tls_proxy listen_port target_host target_port server_cert server_key`` - Only available if asio support was enabled. Listens on a port and + Only available if Boost.Asio support was enabled. Listens on a port and forwards all connects to a target server specified at ``target_host`` and ``target_port``. -- cgit v1.2.3