Skip to content

Commit 1c6716f

Browse files
committed
Move help message to seperate file.
1 parent 1008e56 commit 1c6716f

File tree

2 files changed

+43
-38
lines changed

2 files changed

+43
-38
lines changed

Resources/help-page.txt

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
Configure the boot environment for a Windows installation.
2+
3+
Options:
4+
5+
<source> Mount point of the Windows partition or path to
6+
a virtual disk (VHDX) file containing a Windows
7+
image. A list of partitions on the virtual disk
8+
will be displayed to assist making a selection.
9+
-f, --firmware Specify the firmware type as UEFI, BIOS or BOTH.
10+
-s, --syspath Mount point of the system partition. (Optional)
11+
-d, --wbmdefault Preserve the existing default entry in {bootmgr}
12+
this will be ignored when creating a new BCD store.
13+
-n, --prodname Specify the display name for the new OS entry
14+
otherwise use the product name from the registry.
15+
-l, --locale Specify the locale parameter. (Default is en-us)
16+
-e, --addtoend Add the Windows Boot Manager to the end of the
17+
UEFI boot order otherwise it will be added first
18+
when missing or creating new BCD stores. The WBM
19+
position will be preserved by default when updating
20+
existing BCD hives if already present.
21+
-v, --verbose Display progress for all steps in the configuration
22+
process and show loader/resume GUIDs of new entry.
23+
-c, --clean Remove existing BCD stores and create new entries.
24+
-h, --help Display this help message.
25+
26+
This script will copy the boot files, if missing or outdated, from
27+
the Windows installation located at <source> to a system partition
28+
on either the same drive or the first drive (/dev/sda) whichever
29+
exists. Alternatively a volume mounted at <system> can be specified
30+
using the --syspath option. Any duplicate objects will be deleted
31+
from an existing BCD when creating new entries. The system template
32+
at Windows/System32/config/BCD-Template is currently ignored.
33+
34+
The default firmware type is the same type running under Linux. UEFI
35+
is supported on GPT and MBR disks while BIOS or BOTH requires legacy
36+
bootable MBR partitions with boot sectors created using a tool like
37+
ms-sys. The Windows Boot Manager will be added to the UEFI firmware
38+
boot menu except when using the --syspath option which must rely on
39+
the default path at /EFI/BOOT/BOOTX64.efi
40+
41+
Read "Windows VHDX Native Boot.txt" under the Resources folder for
42+
instructions on setting up a Windows installation on a virtual disk.

bcd-sys.sh

100644100755
Lines changed: 1 addition & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -30,45 +30,8 @@ exit 1
3030
help () {
3131
echo "Usage: $(basename $0) <source> [options] <system>"
3232
echo
33-
echo "Configure the boot environment for a Windows installation."
33+
cat $resdir/Resources/help-page.txt
3434
echo
35-
echo "Options:"
36-
echo
37-
echo "<source> Mount point of the Windows partition or path to"
38-
echo " a virtual disk (VHDX) file containing a Windows"
39-
echo " image. A list of partitions on the virtual disk"
40-
echo " will be displayed to assist making a selection."
41-
echo "-f, --firmware Specify the firmware type as UEFI, BIOS or BOTH."
42-
echo "-s, --syspath Mount point of the system partition. (Optional)"
43-
echo "-d, --wbmdefault Preserve the existing default entry in {bootmgr}"
44-
echo " this will be ignored when creating a new BCD store."
45-
echo "-n, --prodname Specify the display name for the new OS entry"
46-
echo " otherwise use the product name from the registry."
47-
echo "-l, --locale Specify the locale parameter. (Default is en-us)"
48-
echo "-e, --addtoend Add the Windows Boot Manager to the end of the"
49-
echo " UEFI boot order otherwise it will be added first"
50-
echo " when missing or creating new BCD stores. The WBM"
51-
echo " position will be preserved by default when updating"
52-
echo " existing BCD hives if already present."
53-
echo "-v, --verbose Display progress for all steps in the configuration"
54-
echo " process and show loader/resume GUIDs of new entry."
55-
echo "-c, --clean Remove existing BCD stores and create new entries."
56-
echo "-h, --help Display this help message."
57-
echo
58-
echo "This script will copy the boot files, if missing or outdated, from"
59-
echo "the Windows installation located at <source> to a system partition"
60-
echo "on either the same drive or the first drive (/dev/sda) whichever"
61-
echo "exists. Alternatively a volume mounted at <system> can be specified"
62-
echo "using the --syspath option. Any duplicate objects will be deleted"
63-
echo "from an existing BCD when creating new entries. The system template"
64-
echo "at Windows/System32/config/BCD-Template is currently ignored."
65-
echo
66-
echo "The default firmware type is the same type running under Linux. UEFI"
67-
echo "is supported on GPT and MBR disks while BIOS or BOTH requires legacy"
68-
echo "bootable MBR partitions with boot sectors created using a tool like"
69-
echo "ms-sys. The Windows Boot Manager will be added to the UEFI firmware"
70-
echo "boot menu except when using the --syspath option which must rely on"
71-
echo "the default path at /EFI/BOOT/BOOTX64.efi"
7235
exit
7336
}
7437

0 commit comments

Comments
 (0)