diff options
| author | Laurent Bercot <ska-skaware@skarnet.org> | 2020-12-06 21:07:44 +0000 |
|---|---|---|
| committer | Laurent Bercot <ska-skaware@skarnet.org> | 2020-12-06 21:07:44 +0000 |
| commit | 46b44d5f433764fb7976da47f449b35d31b04098 (patch) | |
| tree | 5ad4103bc63ec63867434a2a65b355dcf27b5d87 /doc | |
| parent | 84a2d25e5995a55729b27cbd0502b5cb2745e554 (diff) | |
| download | utmps-46b44d5f433764fb7976da47f449b35d31b04098.tar.xz | |
Prepare for 0.1.0.0; don't install utmpx.h by default
New --enable-libc-includes configure option to overwrite the
system utmpx.h
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/index.html | 4 | ||||
| -rw-r--r-- | doc/libutmps/index.html | 25 | ||||
| -rw-r--r-- | doc/upgrade.html | 6 |
3 files changed, 29 insertions, 6 deletions
diff --git a/doc/index.html b/doc/index.html index 247a9a0..a911019 100644 --- a/doc/index.html +++ b/doc/index.html @@ -70,13 +70,13 @@ suitable replacement for <p> utmps is free software. It is available under the -<a href="http://opensource.org/licenses/ISC">ISC license</a>. +<a href="https://opensource.org/licenses/ISC">ISC license</a>. </p> <h3> Download </h3> <ul> - <li> The current released version of utmps is <a href="utmps-0.0.3.3.tar.gz">0.0.3.3</a>. </li> + <li> The current released version of utmps is <a href="utmps-0.1.0.0.tar.gz">0.1.0.0</a>. </li> <li> Alternatively, you can checkout a copy of the <a href="//git.skarnet.org/cgi-bin/cgit.cgi/utmps/">utmps git repository</a>: diff --git a/doc/libutmps/index.html b/doc/libutmps/index.html index f2fb86f..dc41fda 100644 --- a/doc/libutmps/index.html +++ b/doc/libutmps/index.html @@ -35,6 +35,17 @@ interface, which in utmps is implemented as a series of thin wrappers around the utmps library. </p> +<p> + A suitable <tt>utmpx.h</tt> header can be found in the <tt>utmps/</tt> +subdirectory of +the header installation directory; if the <tt>--enable-libc-includes</tt> +option has been given to configure, it can also be found directly +in that directory. (Example: <tt>/usr/include/utmps/utmpz.h</tt> is +always installed, but if the option has been given at nsss build time, +<tt>/usr/include/utmpx.h</tt> is also installed and replaces the +version provided by the libc.) +</p> + <h2> Compiling </h2> <ul> @@ -42,9 +53,17 @@ around the utmps library. are visible in your header search path. </li> <li> Use <tt>#include <utmps/utmps.h></tt> </li> <li> To use the standard <tt>utmpx.h</tt> interface, you can -just <tt>#include <utmpx.h></tt>, which will work as long -as the <tt>utmps/utmpx.h</tt> header is accessible in your header -search path. </li> +just <tt>#include <utmpx.h></tt>, which will work: + <ul> + <li> either if the <tt>--enable-libc-includes</tt> option +has been given at utmps build time </li> + <li> or if you give the <tt>-I/usr/include/utmps</tt> option +to your compiler. (Depending on your standard header location, +specify that the header search path should include the +<tt>utmps</tt> subdirectory of that location.) This is useful when +the administrator did not want to overwrite the libc-provided +<tt>utmpx.h</tt> file when they installed utmps. </li> + </ul> </li> </ul> <h2> Linking </h2> diff --git a/doc/upgrade.html b/doc/upgrade.html index d700919..a01dfc3 100644 --- a/doc/upgrade.html +++ b/doc/upgrade.html @@ -18,13 +18,17 @@ <h1> What has changed in utmps </h1> -<h2> in 0.0.3.3 </h2> +<h2> in 0.1.0.0 </h2> <ul> <li> <a href="//skarnet.org/software/skalibs/">skalibs</a> dependency bumped to 2.10.0.0. </li> <li> <a href="//skarnet.org/software/s6/">s6</a> run-time dependency bumped to 2.10.0.0. </li> + <li> The <tt>utmpx.h</tt> header files is +not installed by default anymore. You now need to explicitly give the +<tt>--enable-libc-includes</tt> configure option in order to install it. The +point of this change is to avoid overwriting libc headers accidentally. </li> </ul> <h2> in 0.0.3.2 </h2> |