Become REUSE-compliant

WoeUSB

https://github.com/WoeUSB/WoeUSB

A Microsoft Windows® USB installation media preparer for GNU+Linux

Features

Support Legacy PC/UEFI booting
Support FAT32 and NTFS filesystems
Support using physical installation disc or disk image as source

Supported Windows® installation images

Windows Vista and later
Any language or edition variants
Windows PE

NOTE: Non official installation media may be supported, but not guaranteed

Dependencies

The following are the dependencies that WoeUSB requires, in one way or another. Refer the wiki for distro-specific information.

Required

WoeUSB will not be able to function without these software installed in their proper locations:

GNU Bash
For interpreting and executing the program logic
Requires >= 4.3
The GNU Core Utilities(Coreutils)
For common Unix utilities necessary for basic operations
util-linux
For low-level utilities interacting with storage devices, etc
GNU Grep and Gawk
For parsing necessary information out from a command output
The GNU Find Utilities
For enumerating files required for operation
GNU GRUB
For installing the bootstrap code used in a Legacy PC boot
We specifically requires modules of the i386-pc architecture, for Debian-based distributions these are provided via the grub-pc-bin package
GNU Parted
For manipulating disk partition table and partitions
GNU Wget
For acquiring Pete Batard's UEFI:NTFS UEFI bootloader
dosfstools
For creating FAT filesystem in --device creation method
NTFS-3G
For creating NTFS filesystem in --device creation method
wimlib
For splitting install.wim Windows Imaging (WIM) archive so that archives over 4GiB can be fit in an FAT32 filesystem

Optional

Without the following dependencies WoeUSB will still able to run, but some functionalities will be unavailable:

p7zip
For workaround the problem where the Windows 7 installation media doesn't ship their UEFI bootloader in the proper location
Pete Batard's UEFI:NTFS UEFI bootloader
For supporting NTFS filesystems in the target USB key
GNU gettext
For supporting message internationalization(I18N)

Installation

To be addressed. For now refer Run from source.

Run from source

WoeUSB is a program that can be run without installation(excluding its dependencies):

Download the program(woeusb-N.N.N.bash) from the Releases page
Fix the missing executable file permission (chmod +x path/to/woeusb-N.N.N.bash)
Launch a terminal application and run the program via the appropriate path(sudo path/to/woeusb-N.N.N.bash --help)

Usage

Environment variables

The following are the environment variables that may change WoeUSB's runtime behavior:

Variable name	Usage
RUFUS_UEFI_NTFS_VERSION	The release tag/revision of the Rufus source tree to fetch the UEFI:NTFS image from, will use a tested version by default

License

WoeUSB is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

WoeUSB is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with WoeUSB. If not, see http://www.gnu.org/licenses/.

Identify otherwise specified licenses applicable to a certain product/development asset

If the asset is in plaintext format:

Check the SPDX-License-Identifier tag in the file's header
Check the .reuse/dep5 file from the source tree/release tree directory

If the asset is not in plaintext format:

Check the .reuse/dep5 file from the source tree/release tree directory

Credits

WoeUSB is a fork of Colin GILLE's WinUSB project, without standing on their shoulders WoeUSB will not exist in the first place
We would like to thank @slacka for the maintenance of the WoeUSB project when it was hosted under their namespace, they have been extremely helpful and cooperative in many conversations that contributed in WoeUSB's improvement
We would like to thank Pete Batard for their splendid work on the UEFI:NTFS UEFI bootloader, which is included in WoeUSB to enable the NTFS filesystem support
Source code contributors on GitHub:
- Contributors to WoeUSB/WoeUSB
- Contributors to slacka/WoeUSB
Everyone who have contributed to WoeUSB in one way or another but we're unable to enumerate them due to our ignorance

	if [ ! "$(id --user)" = 0 ]; then
	printf_with_color \
	yellow \
	'%s\n%s\n' \
	"Warning: You are not running ${application_name} as root!" \
	'Warning: This might be the reason of the following failure.' >&2
	fi

	if ! mount_source_filesystem \
	"${source_media}" \
	"${source_fs_mountpoint}"; then
	echo_with_color red 'Error: Unable to mount source filesystem'
	exit 1
	fi

	if ! mount_target_filesystem \
	"${target_partition}" \
	"${target_fs_mountpoint}" \
	"${target_filesystem_type}"; then
	echo_with_color red 'Error: Unable to mount target filesystem'
	exit 1
	fi

	if [ "${#parameters[@]}" -lt 2 ]; then
	echo_with_color \
	red \
	"${FUNCNAME[0]}: Error: --partition option requires 2 arguments!"
	return 1
	fi

	if [ "${#parameters[@]}" -lt 2 ]; then
	echo_with_color \
	red \
	"${FUNCNAME[0]}: Error: --device option requires 2 arguments!"
	return 1
	fi

	if [ ${#parameters[@]} -lt 1 ]; then
	printf_with_color \
	red \
	'%s: %s\n' \
	"${FUNCNAME[0]}" \
	'ERROR: --label option requires 1 argument.'
	return 1
	fi

	if \
	[ "${enable_partition}" == true ] \
	&& [ "${enable_label}" == true ]; then
	echo_with_color red "${FUNCNAME[0]}: Error: --label option only can be used with --device creation method"
	return 1
	fi

	if \
	[ "${enable_target_filesystem}" == true ] \
	&& [ "${enable_partition}" == true ]; then
	echo_with_color red "${FUNCNAME[0]}: Error: --target-filesystem option only can be used with --device creation method"
	return 1
	fi

	if ! command -v "${required_command}" >/dev/null; then
	echo_with_color red "${FUNCNAME[0]}: Error: ${application_name} requires ${required_command} command in the executable search path, but it is not found."
	result=failed
	fi

	else
	echo_with_color red \
	"${FUNCNAME[0]}: Error: mkdosfs/mkfs.msdos/mkfs.vfat/mkfs.fat command not found!" >&2
	echo_with_color red \
	"${FUNCNAME[0]}: Error: Please make sure that dosfstools is properly installed!" >&2
	result='failed'
	fi

	else
	printf_with_color red \
	'%s\n%s\n' \
	"${FUNCNAME[0]}: Error: mkntfs command not found!" \
	"${FUNCNAME[0]}: Error: Please make sure that ntfs-3g is properly installed!"
	result=failed
	fi

	if [ "${install_mode_ref}" = device ] \
	&& [[ "${target_media}" =~ .*[0-9] ]]
	then
	echo_with_color red "${FUNCNAME[0]}: Error: Target media \"${target_media_ref}\" is not an entire storage device!"
	return 1
	fi

	if [ "${install_mode_ref}" = partition ] \
	&& ! [[ "${target_media}" =~ .*[0-9] ]]
	then
	echo_with_color red "${FUNCNAME[0]}: Error: Target media \"${target_media_ref}\" is not an partition!"
	return 1
	fi

	printf -- \
	'%s: Error: Unsupported target filesystem "%s", currently supported target filesystems: %s, %s' \
	"${FUNCNAME[0]}" \
	"${target_filesystem_type_libblkid}" \
	"${ENUM_SUPPORTED_FILESYSTEMS[FS_FAT]}" \
	"${ENUM_SUPPORTED_FILESYSTEMS[FS_NTFS]}"
	return 1

	if [ "${verbose}" = true ]; then
	echo "${FUNCNAME[0]}: Info: Target device is '${target_device_ref}'."
	echo "${FUNCNAME[0]}: Info: Target partition is '${target_partition_ref}'."
	if [ "${install_mode}" = partition ]; then
	echo "${FUNCNAME[0]}: Info: Target filesystem is '${ENUM_SUPPORTED_FILESYSTEMS[$target_filesystem_type]}'."
	fi
	fi

	if [ "$(mount \
	\| grep \
	--count \
	--fixed-strings \
	"${source_media}"
	)" != 0 ]; then
	echo_with_color red "Error: Source media is currently mounted, unmount the partition then try again"
	exit 1
	fi

	printf_with_color \
	green \
	'%s\n' \
	'Making system realize that partition table has changed...'

	printf_with_color \
	red \
	'%s\n' \
	"${FUNCNAME[0]}: FATAL: Illegal parted_mkpart_fs_type, please report bug."

	printf_with_color \
	red \
	'Error: %s: Partition is still detected after wiping all signatures, this indicates that the drive might be locked into readonly mode due to end of lifespan.\n' \
	"${FUNCNAME[0]}"

woeusb / woeusb Goto Github PK

woeusb's Introduction

WoeUSB

Features

Supported Windows® installation images

Dependencies

Required

Optional

Installation

Run from source

Usage

Environment variables

License

Identify otherwise specified licenses applicable to a certain product/development asset

Credits

woeusb's People

Contributors

Stargazers

Watchers

Forkers

woeusb's Issues

Is your feature request related to a problem? Please describe

Describe the solution you'd like

Describe alternatives you've considered

Additional context

Describe the bug

Describe the bug

Environment

Describe the bug

Expected behavior

Describe the bug

Expected behavior

Rationale

Implementation detail

Is your feature request related to a problem? Please describe

Describe the solution you'd like

Describe alternatives you've considered

Additional context

Describe the bug

Is your feature request related to a problem? Please describe.

Describe the solution you'd like

Describe alternatives you've considered

Additional context

Is your feature request related to a problem? Please describe

Describe the solution you'd like

Describe alternatives you've considered

Additional context

Describe the bug

To Reproduce

Expected behavior

Teminal output

Environment

Additional context

Describe the bug

Describe the bug

To Reproduce

Expected behavior

Teminal output

Environment

[welon@wel windows10]$ [welon@wel windows10]$ sudo woeusb --device Win10_1803_Polish_x64.iso /dev/sdf --target-filesystem NTFS [sudo] hasło użytkownika welon: WoeUSB v5.0.4

Is your feature request related to a problem? Please describe

Describe the solution you'd like

Describe alternatives you've considered

Additional context

Is your feature request related to a problem? Please describe

Describe the solution you'd like

Describe alternatives you've considered

To Reproduce

Expected behavior

Inspiration

Describe the bug

Describe the bug

Expected behavior

Environment

bhante@subhuntu:~/Downloads$ sudo /snap/bin/woe-usb.woeusb --device Win10.iso /dev/sda --tgt-fs NTFS WoeUSB v@@WOEUSB_VERSION@@

Is your feature request related to a problem? Please describe

Describe the solution you'd like

Describe alternatives you've considered

Additional context

Is your feature request related to a problem? Please describe

[welon@wel windows10]$
[welon@wel windows10]$ sudo woeusb --device Win10_1803_Polish_x64.iso /dev/sdf --target-filesystem NTFS
[sudo] hasło użytkownika welon:
WoeUSB v5.0.4

bhante@subhuntu:~/Downloads$ sudo /snap/bin/woe-usb.woeusb --device Win10.iso /dev/sda --tgt-fs NTFS
WoeUSB v@@WOEUSB_VERSION@@