@@ -93,13 +93,24 @@ The following list does not claim to be complete resp. to be available across al
9393| ` timing ` | builds the ` timing ` binary, which can be used to measure timings for algorithms and modes * \* 4* * \* 6* |
9494| ` bins ` | builds ` hashsum ` * \* 4* |
9595| ` all_test ` | builds ` test ` , ` hashsum ` , ` ltcrypt ` , ` small ` , ` tv_gen ` , ` sizes ` & ` constants ` * \* 4* |
96+ | ` docs ` | builds the developer documentation ` doc/crypt.pdf ` |
97+ | ` install ` | installs the ` library ` and header files * \* 7* * \* 8* |
98+ | ` install_bins ` | installs the binaries created by the ` bins ` target * \* 7* * \* 8* |
99+ | ` install_docs ` | installs the documentation created by the ` docs ` target * \* 7* * \* 8* |
100+ | ` install_test ` | installs the test-app created by the ` test ` target * \* 7* * \* 8* |
101+ | ` install_all ` | installs everything (i.e. ` library ` , ` bins ` , ` docs ` and ` test ` ) * \* 8* |
102+ | ` uninstall ` | uninstalls the ` library ` and header files |
96103
97104* \* 4* also builds ` library `
98105
99106* \* 5* broken build in some configurations, therefore not built by default
100107
101108* \* 6* requires define of one of ` USE_GMP ` , ` USE_LTM ` or ` USE_TFM ` (+ the appropriate MPI provider)
102109
110+ * \* 7* also builds the necessary artifact(s) before installing it
111+
112+ * \* 8* also have a look at the 'Installation' section of this file
113+
103114### Examples
104115
105116You want to build the library as static library
@@ -125,3 +136,37 @@ You have `gmp`, `libtommath` and `tomsfastmath` installed on your system and wan
125136If you have ` libtommath ` in a non-standard location:
126137
127138 make CFLAGS="-DUSE_LTM -DLTM_DESC -I/opt/devel/ltm" EXTRALIBS="/opt/devel/ltm/libtommath.a" all
139+
140+ ## Installation
141+
142+ There exist several _ install_ make-targets which are described in the table above.
143+
144+ These targets support the standard ways (c.f. [[ GNU]] , [[ FreeBSD]] )
145+ to modify the installation path via the following set of variables:
146+
147+ DESTDIR
148+ PREFIX
149+ LIBPATH
150+ INCPATH
151+ DATAPATH
152+ BINPATH
153+
154+ The entire set of the variables is only supported in ` makefile ` , ` makefile.shared ` and ` makefile.unix ` .
155+
156+ In case you have to use one of the other makefiles, check in the file which variables are supported.
157+
158+ ### Examples
159+
160+ You want to install the static library to the default paths
161+
162+ make install
163+
164+ You want to install the shared library to a special path and use it from this path
165+
166+ make -f makefile.shared PREFIX=/opt/special/path
167+
168+ Have a look at the developer documentation, [[ GNU]] or [[ FreeBSD]] to get a detailed explanation of all the variables.
169+
170+ [ GNU ] : https://www.gnu.org/prep/standards/html_node/DESTDIR.html
171+
172+ [ FreeBSD ] : https://www.freebsd.org/doc/en/books/porters-handbook/porting-prefix.html
0 commit comments