]> wimlib.net Git - wimlib/blobdiff - README
Upgrade WIM mounting support from fuse2 to fuse3
[wimlib] / README
diff --git a/README b/README
index 56ae7417e4cc4aa6cfaab60a9a58fc5b39730744..f9447c93703d7be5a1a384912e81290d3551b707 100644 (file)
--- a/README
+++ b/README
@@ -1,6 +1,6 @@
                                   INTRODUCTION
 
-This is wimlib version 1.13.3 (October 2020).  wimlib is a C library for
+This is wimlib version 1.14.0-BETA2 (March 2023).  wimlib is a C library for
 creating, modifying, extracting, and mounting files in the Windows Imaging
 Format (WIM files).  wimlib and its command-line frontend 'wimlib-imagex'
 provide a free and cross-platform alternative to Microsoft's WIMGAPI, ImageX,
@@ -122,31 +122,20 @@ with it, when building for a UNIX-like system from source.  If you have
 downloaded the Windows binary distribution of wimlib and wimlib-imagex then all
 dependencies were already included and this section is irrelevant.
 
-* libxml2 (required)
-       This is a commonly used free library to read and write XML documents.
-       Almost all Linux distributions should include this; however, you may
-       need to install the header files, which might be in a package named
-       "libxml2-dev" or similar.  For more information see http://xmlsoft.org/.
-
-* libfuse (optional but recommended)
-       Unless configured --without-fuse, wimlib requires a non-ancient version
-       of libfuse.  Most Linux distributions already include this, but make
-       sure you have the libfuse package installed, and also libfuse-dev if
-       your distribution distributes header files separately.  FUSE also
-       requires a kernel module.  If the kernel module is available it should
-       automatically be loaded if you try to mount a WIM image.  For more
-       information see http://fuse.sourceforge.net/.
+* libfuse3 (optional but recommended)
+       Unless configured --without-fuse, wimlib requires libfuse3, for the
+       support for mounting WIM images.  Most Linux distributions already
+       include this, but make sure you have the fuse3 package installed, and
+       also libfuse3-dev if your distribution distributes development files
+       separately.  FUSE also requires a kernel module.  If the kernel module
+       is available it should automatically be loaded if you try to mount a WIM
+       image.  For more information, see https://github.com/libfuse/libfuse/.
 
 * libntfs-3g (optional but recommended)
        Unless configured --without-ntfs-3g, wimlib requires the library and
        headers for libntfs-3g to be installed.  The minimum required version is
        2011-4-12, but newer versions contain important bug fixes.
 
-* OpenSSL / libcrypto (optional)
-       wimlib can use the SHA-1 message digest implementation from libcrypto
-       (usually provided by OpenSSL) instead of compiling in yet another SHA-1
-       implementation.
-
 * cdrkit (optional)
 * mtools (optional)
 * syslinux (optional)
@@ -155,10 +144,10 @@ dependencies were already included and this section is irrelevant.
        depending on what options are given to it.  Depending on your Linux
        distribution, you may already have these programs installed, or they may
        be in the software repository.  Making an ISO filesystem requires
-       `mkisofs' from `cdrkit' (http://www.cdrkit.org).  Making a disk image
-       requires `mtools' (http://www.gnu.org/software/mtools) and `syslinux'
-       (http://www.syslinux.org).  Retrieving files from the Windows Automated
-       Installation Kit requires `cabextract' (http://www.cabextract.org.uk).
+       `mkisofs' from `cdrkit' (https://www.cdrkit.org).  Making a disk image
+       requires `mtools' (https://www.gnu.org/software/mtools) and `syslinux'
+       (https://www.syslinux.org).  Retrieving files from the Windows Automated
+       Installation Kit requires `cabextract' (https://www.cabextract.org.uk).
 
                                  CONFIGURATION
 
@@ -181,16 +170,10 @@ This section documents the most important options that may be passed to the
        The default is --with-fuse when building for Linux, and --without-fuse
        otherwise.
 
---without-libcrypto
-       Build in functions for SHA-1 rather than using external SHA-1 functions
-       from libcrypto (usually provided by OpenSSL).
-
-       The default is to use libcrypto if it is found on your system.
-
                                   PORTABILITY
 
 wimlib works on both UNIX-like systems (Linux, Mac OS X, FreeBSD, etc.) and
-Windows (XP and later).
+Windows (Vista and later).
 
 As much code as possible is shared among all supported platforms, but there
 necessarily are some differences in what features are supported on each platform
@@ -228,8 +211,8 @@ science papers.
 
 The code in ntfs-3g_apply.c and ntfs-3g_capture.c uses the NTFS-3G library,
 which is a library for reading and writing to NTFS filesystems (the filesystem
-used by recent versions of Windows).  See
-http://www.tuxera.com/community/open-source-ntfs-3g/ for more information.
+used by recent versions of Windows).  For more information about NTFS-3G, see
+https://github.com/tuxera/ntfs-3g/.
 
 A limited number of other free programs can handle some parts of the WIM
 file format:
@@ -247,16 +230,16 @@ file format:
 
 If you are looking for an archive format that provides features similar to WIM
 but was designed primarily for UNIX, you may want to consider SquashFS
-(http://squashfs.sourceforge.net/).  However, you may find that wimlib works
-surprisingly well on UNIX.  It will store hard links and symbolic links, and it
-supports storing standard UNIX file permissions (owners, groups, and modes);
-special files such as device nodes and FIFOs; and extended attributes.
-Actually, I use it to back up my own files on Linux!
+(https://docs.kernel.org/filesystems/squashfs.html).  However, you may find that
+wimlib works surprisingly well on UNIX.  It will store hard links and symbolic
+links, and it supports storing standard UNIX file permissions (owners, groups,
+and modes); special files such as device nodes and FIFOs; and extended
+attributes.  Actually, I use it to back up my own files on Linux!
 
                                     HISTORY
 
 wimlib was originally a project started by Carl Thijssen for use on Linux in the
-Ultimate Deployment Appliance (http://www.ultimatedeployment.org/).  Since then
+Ultimate Deployment Appliance (https://www.ultimatedeployment.org/).  Since then
 the code has been entirely rewritten and improved (main author: Eric Biggers).
 Windows support has been available since version 1.3.0 (March 2013).  A list of
 version-to-version changes can be found in the NEWS file.
@@ -271,12 +254,3 @@ posted to https://wimlib.net/forums/.
 
 wimlib is independently developed and does not contain any code, data, or files
 copyrighted by Microsoft.  It is not known to be affected by any patents.
-
-On UNIX-like systems, if you do not want wimlib to be dynamically linked with
-libcrypto (OpenSSL), configure with --without-libcrypto.  This replaces the SHA1
-implementation with built-in code and there will be no difference in
-functionality.
-
-Note: copyright years may be listed using range notation, e.g., 2012-2016,
-indicating that every year in the range, inclusive, is a copyrightable year that
-would otherwise be listed individually.