X-Git-Url: https://wimlib.net/git/?p=wimlib;a=blobdiff_plain;f=include%2Fwimlib.h;h=46c5bc0fdd0e94aa6893a8359faabb76c0bb2919;hp=63cc3e200c2b0e486a24ec65606019f3d18f7d15;hb=719a063c87e3abab99b0fb53ebc80223fbf33123;hpb=8b709192cd2811b83c248fbe61ca4f11ee9de797 diff --git a/include/wimlib.h b/include/wimlib.h index 63cc3e20..46c5bc0f 100644 --- a/include/wimlib.h +++ b/include/wimlib.h @@ -3,9 +3,9 @@ * @brief External header for wimlib. * * This file contains comments for generating documentation with Doxygen. The - * built HTML documentation can be viewed at http://wimlib.sourceforge.net. - * Make sure to see the Modules page to make more - * sense of the declarations in this header. + * built HTML documentation can be viewed at http://wimlib.net/apidoc. Make + * sure to see the Modules page to make more sense of + * the declarations in this header. */ /** @@ -16,39 +16,35 @@ * Windows Imaging Format. This documentation is intended for developers only. * If you have installed wimlib and want to know how to use the @b wimlib-imagex * program, please see the manual pages and also the README + * href="http://wimlib.net/gitlist/wimlib/blob/master/README">README * file. * * @section sec_installing Installing * * @subsection UNIX * - * Download the source code from http://sourceforge.net/projects/wimlib/files. - * Install the library by running configure && make && sudo make install. - * See the README for information about configuration options. To use wimlib in - * your program after installing it, include wimlib.h and link your program with - * -lwim. + * Download the source code from http://wimlib.net. Install the library by + * running configure && make && sudo make install. See the README for + * information about configuration options. To use wimlib in your program after + * installing it, include wimlib.h and link your program with -lwim. * * @subsection Windows * * Download the Windows binary distribution with the appropriate architecture - * (i686 or x86_64 --- also called "x86" and "amd64" respectively) from http://sourceforge.net/projects/wimlib/files. - * Link your program with the libwim-15.dll file. Make sure to also download - * the source code so you can get wimlib.h, as it is not included in the binary - * distribution. If you need to access the DLL from other programming - * languages, note that the calling convention is "cdecl". + * (i686 or x86_64 --- also called "x86" and "amd64" respectively) from + * http://wimlib.net. Link your program with the libwim-15.dll file. Make sure + * to also download the source code so you can get wimlib.h, as it is not + * included in the binary distribution. If you need to access the DLL from + * other programming languages, note that the calling convention is "cdecl". * * @section sec_examples Examples * - * Several examples are located in the examples - * directory of the source distribution. + * Several examples are located in the "examples" directory of the source + * distribution. * * There is also the - * source code of wimlib-imagex, which is complicated but uses most + * href="http://wimlib.net/gitlist/wimlib/blob/master/programs/imagex.c"> source + * code of wimlib-imagex, which is complicated but uses most * capabilities of wimlib. * * @section backwards_compatibility Backwards Compatibility @@ -1944,13 +1940,14 @@ typedef int (*wimlib_iterate_lookup_table_callback_t)(const struct wimlib_resour */ #define WIMLIB_EXTRACT_FLAG_WIMBOOT 0x00400000 -/** EXPERIMENTAL and only works on Windows 10 and later: compress the extracted - * files using the System Compression feature (when possible). System - * Compression is only supported by Windows 10 or later. Several different - * compression formats may be used with System Compression; this particular flag - * selects the XPRESS compression format with 4096 byte chunks. This flag is - * currently experimental and may be changed or removed in future releases of - * wimlib. */ +/** + * EXPERIMENTAL, Windows-only: compress the extracted files using System + * Compression, when possible. This only works on either Windows 10 or later, + * or on an older Windows to which Microsoft's wofadk.sys driver has been added. + * Several different compression formats may be used with System Compression; + * this particular flag selects the XPRESS compression format with 4096 byte + * chunks. This flag is currently experimental and may be changed or removed + * in future releases of wimlib. */ #define WIMLIB_EXTRACT_FLAG_COMPACT_XPRESS4K 0x01000000 /** Like ::WIMLIB_EXTRACT_FLAG_COMPACT_XPRESS4K, but use XPRESS compression with