wimlib.net Git - wimlib/blob - doc/imagex-extract.1.in

   1 .TH IMAGEX "1" "May 2013" "@IMAGEX_PROGNAME@ @VERSION@" "User Commands"
   2 .SH NAME
   3 @IMAGEX_PROGNAME@-extract \- Extract files or directories from a WIM image
   4 .SH SYNOPSIS
   5 \fB@IMAGEX_PROGNAME@ extract\fR \fIWIMFILE\fR \fIIMAGE\fR [\fIPATH\fR...]  [\fIOPTION\fR...]
   6 .SH DESCRIPTION
   7 \fB@IMAGEX_PROGNAME@ extract\fR extracts one or more files or directory trees
   8 from the specified \fIIMAGE\fR contained in the Windows Imaging (WIM) file
   9 \fIWIMFILE\fR.
  10 .PP
  11 \fB@IMAGEX_PROGNAME@ extract\fR is intended for extracting only a subset of a
  12 WIM image.  If you want to extract or "apply" a full WIM image to a directory or
  13 NTFS volume, use \fB@IMAGEX_PROGNAME@ apply\fR (1) instead.
  14 .PP
  15 \fIIMAGE\fR specifies the image in \fIWIMFILE\fR that contains the files or
  16 directory trees to extract.  It may be a 1-based index of an image in the WIM or
  17 the name of an image in the WIM.  Use the \fB@IMAGEX_PROGNAME@ info\fR (1)
  18 command to show what images a WIM file contains.
  19 .PP
  20 Each \fIPATH\fR specifies a file or directory tree within the WIM image to
  21 extract.  See \fBPATH_SPECIFICATIONS\fR.
  22 .PP
  23 By default, files and directories are extracted to the current directory.  Use
  24 \fB--dest-dir\fR to choose an alternate target directory.  Alternatively, use
  25 \fB--to-stdout\fR to extract a file to standard output to pipe into another
  26 program.
  27 .PP
  28 \fB@IMAGEX_PROGNAME@ extract\fR supports extracting files and directory trees
  29 from stand-alone WIMs as well as split WIMs.  See \fBSPLIT WIMS\fR.
  30 .SH PATH SPECIFICATIONS
  31 Each \fIPATH\fR specifies a file or directory tree within the WIM image to
  32 extract.  Each path must be specified as an absolute path starting from the root
  33 of the WIM image, like those output by the \fB@IMAGEX_PROGNAME@ dir\fR (1)
  34 command.  Path separators may be forward slashes on UNIX, or either forward
  35 slashes or backward slashes on Windows.  The leading slash is optional.
  36 .PP
  37 If no \fIPATH\fRs are provided, the default behavior is to extract the full
  38 image, as if the path "/" had been provided.
  39 .SH SPLIT WIMS
  40 You may use \fB@IMAGEX_PROGNAME@ extract\fR to extract files or directory trees
  41 from a split WIM.  This uses the \fB--refs\fR="\fIGLOB\fR" option in the same
  42 way as in other commands such as \fB@IMAGEX_PROGNAME@ apply\fR.  See
  43 \fB@IMAGEX_PROGNAME@ apply\fR (1) for more details.
  44 .SH OPTIONS
  45 .TP 6
  46 \fB--check\fR
  47 When reading \fIWIMFILE\fR, verify its integrity if an integrity table is
  48 present.
  49 .TP
  50 \fB--ref\fR="\fIGLOB\fR"
  51 File glob of additional split WIM parts that are part of the split WIM.  See
  52 \fBSPLIT_WIMS\fR.
  53 .TP
  54 \fB--verbose\fR
  55 Print the path of each file or directory within the WIM image as it is
  56 extracted.
  57 .TP
  58 \fB--unix-data\fR
  59 See the documentation for this option in \fB@IMAGEX_PROGNAME@-apply\fR (1).
  60 .TP
  61 \fB--no-acls\fR
  62 See the documentation for this option in \fB@IMAGEX_PROGNAME@-apply\fR (1).
  63 .TP
  64 \fB--strict-acls\fR
  65 See the documentation for this option in \fB@IMAGEX_PROGNAME@-apply\fR (1).
  66 .TP
  67 \fB--to-stdout\fR
  68 Extract the files to standard output instead of to the filesystem.  This can
  69 only be provided if all the specified \fIPATH\fRs are to regular files (not
  70 directories or reparse points).  If present, alternate data streams are not
  71 extracted.
  72 .TP
  73 \fB--dest-dir\fR=\fIDIR\fR
  74 Extract the files and directories to the directory \fIDIR\fR instead of to the
  75 current working directory.
  76 .SH NOTES
  77 See the documentation \fB@IMAGEX_PROGNAME@ apply\fR (1) for documentation about
  78 what data and metadata are extracted on UNIX versus on Windows.
  79 .PP
  80 On UNIX, one can alternatively mount the WIM image with \fB@IMAGEX_PROGNAME@
  81 mount\fR and then extract the desired files or directories using any standard
  82 command-line or graphical program.
  83 .PP
  84 Reparse-point fixups (a.k.a. changing absolute symbolic links and junctions to
  85 point within the extraction location) are never done by \fB@IMAGEX_PROGNAME@
  86 extract\fR.  Use \fB@IMAGEX_PROGNAME@ apply\fR if you want this behavior.
  87 .PP
  88 Unlike \fB@IMAGEX_PROGNAME@ apply\fR, \fB@IMAGEX_PROGNAME@ extract\fR does not
  89 support extracting files directly to a NTFS volume using libntfs-3g.
  90 .SH EXAMPLES
  91 Extract a file from the first image in "boot.wim" to the current directory:
  92 .RS
  93 .PP
  94 @IMAGEX_PROGNAME@ extract boot.wim 1 /Windows/System32/notepad.exe
  95 .RE
  96 .PP
  97 Extract a file from the first image in "boot.wim" to standard output:
  98 .RS
  99 .PP
 100 @IMAGEX_PROGNAME@ extract boot.wim 1 /Windows/System32/notepad.exe --to-stdout
 101 .RE
 102 .PP
 103 Extract a file from the first image in "boot.wim" to the specified directory:
 104 .RS
 105 .PP
 106 @IMAGEX_PROGNAME@ extract boot.wim 1 /Windows/System32/notepad.exe --dest-dir=somedir
 107 .RE
 108 .PP
 109 Extract the "sources" directory from the first image in "boot.wim" to the
 110 current directory:
 111 .RS
 112 .PP
 113 @IMAGEX_PROGNAME@ extract boot.wim 1 /sources
 114 .RE
 115 .PP
 116 Extract multiple files and directories in one command:
 117 .RS
 118 .PP
 119 @IMAGEX_PROGNAME@ extract boot.wim 1 /Windows/Fonts /sources /Windows/System32/cmd.exe
 120 .RE
 121 .PP
 122 .SH SEE ALSO
 123 .BR @IMAGEX_PROGNAME@ (1)
 124 .BR @IMAGEX_PROGNAME@-apply (1)
 125 .BR @IMAGEX_PROGNAME@-dir (1)
 126 .BR @IMAGEX_PROGNAME@-info (1)
 127 .BR @IMAGEX_PROGNAME@-mount (1)