3 # This script can make a customized bootable image of Windows PE.
6 # Copyright (C) 2012, 2013 Eric Biggers
8 # This program is free software: you can redistribute it and/or modify
9 # it under the terms of the GNU General Public License as published by
10 # the Free Software Foundation, either version 3 of the License, or
11 # (at your option) any later version.
13 # This program is distributed in the hope that it will be useful,
14 # but WITHOUT ANY WARRANTY; without even the implied warranty of
15 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 # GNU General Public License for more details.
18 # You should have received a copy of the GNU General Public License
19 # along with this program. If not, see <http://www.gnu.org/licenses/>.
21 script_name="$(basename $0)"
23 WIMLIB_VERSION=@VERSION@
24 imagex=@IMAGEX_PROGNAME@
29 # stty will fail when stdin isn't a terminal
31 # stty gives "rows cols"; strip the rows number, we just want columns
32 STAT_COL=${STAT_COL##* }
33 elif tput cols &>/dev/null; then
34 # is /usr/share/terminfo already mounted, and TERM recognized?
37 if (( STAT_COL == 0 )); then
38 # if output was 0 (serial console), set default width to 80
42 # we use 13 characters for our own stuff
43 STAT_COL=$(( STAT_COL - 13 ))
47 RESTORE_POSITION="\e[u"
48 DEL_TEXT="\e[$(( STAT_COL + 4 ))G"
62 printf "${PREFIX_REG} ${1} "
63 printf "${SAVE_POSITION}"
86 Usage: $script_name [OPTIONS] IMAGE
88 -i, --iso Make an ISO image instead of a disk image.
89 -o, --only-wim Make neither a disk image nor an ISO image;
90 instead, only make a modified boot.wim file.
91 -W, --windows-dir=DIR Use DIR as the location of the mounted Windows 7
92 or Windows 8 DVD. Default is /mnt/windows,
93 then /mnt/windows7, then /mnt/windows8.
94 -A, --waik-dir=DIR Get the boot files and boot.wim from the ISO of the
95 Windows Automated Installation Kit mounted on DIR
96 instead of from the Windows 7 or Windows 8 DVD.
97 -s, --start-script=FILE Add FILE to the root directory of Windows PE image
98 and adjust \Windows\System32\winpeshl.ini to
99 execute FILE when Windows PE starts up.
100 -w, --wim=WIM Use WIM as the boot.wim file. Defaults to
101 sources/boot.wim in the Windows DVD directory, or
102 F1_WINPE.WIM from the WAIK if --waik-dir is
104 -O, --overlay=DIR Adds all the files in DIR to the Windows PE image.
105 -t, --tmp-dir=DIR Use DIR as the temporary base of the ISO filesystem.
106 Defaults to making one using "mktemp -d".
107 -a, --arch=ARCH Use the Windows PE version from the WAIK that has
108 the CPU architecture ARCH. Possible values:
109 "x86" or "amd64". Default is "x86".
110 -h, --help Display this information.
111 -v, --version Show version information.
113 See \`man mkwinpeimg' for more information.
118 echo "$script_name (wimlib $WIMLIB_VERSION)"
124 process_command_line() {
126 if ! options=$(getopt -o oiw:W:s:O:t:A:a:hv -l \
127 only-wim,iso,wim:,windows-dir:,start-script:,overlay:,tmp-dir:,waik-dir:,arch:,help,version \
137 eval set -- "$options"
138 while [ $# -gt 0 ]; do
148 windows_dir_specified=yes
149 if [ -n "$waik_dir" ]; then
150 echo "ERROR: Cannot specify both --windows-dir and --waik-dir!"
157 if [ -n "$windows_dir" ]; then
158 echo "ERROR: Cannot specify both --windows-dir and --waik-dir!"
181 if [ "$2" == "x86" ]; then
184 # Need to test Itanium images before making it an
185 # option. Note: syslinux is x86 only so can't be used
186 # for the Itanium disk image.
187 #elif [ "$2" == "ia64" ]; then
190 elif [ "$2" == "amd64" ]; then
194 echo "ERROR: $2 is not a valid arch (x86/amd64)"
211 echo "Invalid option \"$1\""
219 if [ $# -ne 1 ]; then
220 echo "You must specify the name of the image file to create!"
221 echo "Run \"$script_name -h\" to see usage information."
229 if [ -z "$windows_dir_specified" ]; then
230 for windows_dir in /mnt/windows /mnt/windows7 /mnt/windows8; do
231 if [ -d "$windows_dir"/sources ]; then
236 if [ ! -d "$windows_dir" ]; then
237 if [ -z "$windows_dir_specified" ]; then
239 ERROR: Could not find the directory that the Windows 7 or 8 ISO image is mounted
240 on! Please specify this directory using the --windows-dir option.
243 echo "ERROR: Could not find the directory \"$windows_dir\"!"
247 if [ ! -d "$windows_dir/sources" ]; then
249 ERROR: The directory "$windows_dir" exists, but it seems that the Windows 7 or 8
250 ISO image is not mounted on it. Please mount the image to continue.
256 check_needed_programs() {
257 if [ -z "$waik_dir" -o -n "$modify_wim" ]; then
258 if ! type -P @IMAGEX_PROGNAME@ &> /dev/null ; then
260 ERROR: To make a customized image of Windows PE, we need the "$imagex" program
261 from "wimlib" so that we can modify the boot.wim file. However, "$imagex"
262 doesn't seem to be installed. Please install "wimlib" to continue.
268 if [ $make = iso ]; then
269 if ! type -P mkisofs &> /dev/null ; then
271 ERROR: To make a bootable ISO image of Windows PE, we need the "mkisofs"
272 program, but it doesn't seem to be installed. Please install the "cdrkit"
273 package to continue, or try omitting the --iso option to make a disk image
274 instead of an ISO image.
278 elif [ $make = disk ] ; then
279 if ! type -P syslinux &> /dev/null ; then
281 ERROR: To make a bootable disk image of Windows PE, we need the "syslinux"
282 program, but it doesn't seem to be installed. Please install the "syslinux"
283 package to continue, or try using the --iso option to make an ISO image instead
289 if ! type -P mformat mcopy &> /dev/null; then
291 ERROR: To make a bootable disk image of Windows PE, we need the "mformat" and
292 "mcopy" programs from the "mtools" package. These programs allow us to
293 format a FAT filesystem and copy files to it without needing root privileges.
294 Please install "mtools" if you want to make a disk image of Windows PE. Or,
295 try using the --iso option to make an ISO image instead of a disk image.
300 if [ -n "$waik_dir" ]; then
301 if ! type -P cabextract &> /dev/null ; then
303 ERROR: The boot files in the Windows Automated Installation Kit (WAIK) are
304 inside cabinet archives. To extract these files, we need the "cabextract"
305 program, but it doesn't seem to be installed. Please install "cabextract" to
314 get_primary_boot_files() {
315 if [ -n "$waik_dir" ]; then
316 # Get boot files from the WAIK.
318 stat_busy "Copying primary boot files from the Windows Automated Installation Kit ($waik_dir, $arch)"
319 if [ $make = iso ]; then
320 cabextract "$waik_dir"/wAIK${arch}.msi -F F_WINPE_${arch}_etfsboot.com -p \
321 > "$tmp_dir"/etfsboot.com || stat_fail
323 cabextract "$waik_dir"/wAIK${arch}.msi -F F${arch_id}_BOOTMGR -p \
324 > "$tmp_dir"/bootmgr || stat_fail
325 cabextract "$waik_dir"/wAIK${arch}.msi -F F_WINPE_${arch}_boot.sdi -p \
326 > "$tmp_dir"/boot/boot.sdi || stat_fail
327 cabextract "$waik_dir"/wAIK${arch}.msi -F F_WINPE_${arch}_bcd -p \
328 > "$tmp_dir"/boot/bcd || stat_fail
331 # Get boot files from the Windows ISO
333 stat_busy "Copying primary boot files from mounted Windows DVD ($windows_dir)"
334 if [ $make = iso ]; then
335 cp "$windows_dir"/boot/etfsboot.com "$tmp_dir" || stat_fail
337 cp "$windows_dir"/bootmgr "$tmp_dir" || stat_fail
338 cp "$windows_dir"/boot/{bcd,boot.sdi} "$tmp_dir"/boot || stat_fail
345 # Copy the WIM over, or export the 2nd image in the WIM in the case of boot.wim
346 # from the Windows DVD.
348 if [ -z "$wim" ]; then
350 # WIM file unspecified- grab it from the WAIK or the Windows DVD
351 if [ -n "$waik_dir" ]; then
353 stat_busy "Extracting boot.wim from \"$waik_dir/WinPE.cab\""
354 cabextract "$waik_dir/WinPE.cab" -F F${arch_id}_WINPE.WIM -p \
355 > "$boot_wim" 2>/dev/null || stat_fail
360 wim="$windows_dir/sources/boot.wim"
361 stat_busy "Exporting image from \"$wim\""
362 "$imagex" export "$windows_dir"/sources/boot.wim 2 \
363 --boot "$boot_wim" || stat_fail
368 stat_busy "Copying $wim to temporary directory"
369 cp "$wim" "$boot_wim"|| stat_fail
374 # Make modifications to the WIM.
379 exec 3>"$tmp_dir/__mkwinpeimg.update.cmds"
381 if [ -n "$remove_setup" ]; then
382 stat_busy "Renaming setup.exe to prevent it from bothering us"
384 rename /setup.exe /setup.exe.orig
385 rename /sources/setup.exe /sources/setup.exe.orig
390 if [ -n "$start_script" ]; then
391 stat_busy "Setting \"$start_script\" as the script to be executed when Windows PE boots"
392 cp "$start_script" "$tmp_dir/$start_script"
393 cat > "$tmp_dir/__mkwinpeimg.winpeshl.ini" <<- EOF
395 %SYSTEMDRIVE%\\$start_script
398 add '$tmp_dir/$start_script' '/$start_script'
399 delete --force /Windows/System32/winpeshl.ini
400 add '$tmp_dir/__mkwinpeimg.winpeshl.ini' /Windows/System32/winpeshl.ini
405 if [ -n "$overlay" ]; then
406 stat_busy "Overlaying \"$overlay\" on the Windows PE filesystem"
415 stat_busy "Rebuilding WIM with changes made"
416 "$imagex" update "$boot_wim" --rebuild \
417 < "$tmp_dir/__mkwinpeimg.update.cmds" > /dev/null || stat_fail
424 # Make the ISO using the mkisofs command from cdrkit
426 stat_busy "Making ISO image \"$image\""
428 mkisofs -sysid "" -A "" -V "Microsoft Windows PE ($arch)" -d -N \
429 -b etfsboot.com -no-emul-boot -c boot.cat -hide etfsboot.com \
430 -hide boot.cat -quiet -o "$image" "$tmp_dir" || stat_fail
438 stat_busy "Making disk image \"$image\""
440 image_du=$(du -s -b "$tmp_dir" | cut -f 1)
441 image_size=$(( image_du + 10000000 ))
443 mtool_conf="$(mktemp)"
445 dd if=/dev/zero of="$image" count=$(( (image_size + 4095) / 4096)) \
448 cat > "$mtool_conf" <<- EOF
450 MTOOLS_FAT_COMPATIBILITY=1
455 export MTOOLSRC="$mtool_conf"
457 mformat -h 255 -s 63 -T $(( image_size / 512)) s:
458 mcopy -s "$tmp_dir"/* s:
460 syslinux --install "$image"
461 mcopy /usr/lib/syslinux/chain.c32 s:
462 mcopy - 's:syslinux.cfg' <<- EOF
466 APPEND ntldr=/bootmgr
473 tmp_dir="$(mktemp -d)"
474 process_command_line "$@"
475 if [ -z "$waik_dir" ]; then
478 if [ -n "$start_script" -o -n "$overlay" -o -n "$remove_setup" ]; then
481 check_needed_programs
484 if [ $make != wim ]; then
485 mkdir -p "$tmp_dir"/{boot,sources}
486 get_primary_boot_files
489 if [ $make = wim ]; then
492 boot_wim="$tmp_dir"/sources/boot.wim
495 get_boot_wim "$boot_wim"
497 if [ -n "$modify_wim" ]; then
498 modify_boot_wim "$boot_wim" "$tmp_dir"
501 if [ $make = iso ]; then
502 make_iso_img "$image"
503 elif [ $make = disk ]; then
504 make_disk_img "$image"
507 echo "The image ($image) is $(stat -c %s "$image") bytes."