[mirror_edk2.git] / ShellPkg / Library / UefiShellBcfgCommandLib / UefiShellBcfgCommandLib.uni

// /**\r
//\r
// (C) Copyright 2014-2015 Hewlett-Packard Development Company, L.P.<BR>\r
// Copyright (c) 2010 - 2016, Intel Corporation. All rights reserved.<BR>\r
// This program and the accompanying materials\r
// are licensed and made available under the terms and conditions of the BSD License\r
// which accompanies this distribution. The full text of the license may be found at\r
// http://opensource.org/licenses/bsd-license.php\r
//\r
// THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
// WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
//\r
// Module Name:\r
//\r
// UefiBcfgCommandsLib.uni\r
//\r
// Abstract:\r
//\r
// String definitions for UEFI Shell 2.0 BCFG command\r
//\r
//\r
// **/\r
\r
/=#\r
\r
#langdef   en-US "english"\r
\r
#string STR_GEN_NO_MEM            #language en-US "%H%s%N: Memory is not available.\r\n"\r
#string STR_GEN_PROBLEM           #language en-US "%H%s%N: Unknown flag - '%H%s%N'\r\n"\r
#string STR_GEN_NO_VALUE          #language en-US "%H%s%N: Missing argument for flag - '%H%s%N'\r\n"\r
#string STR_GEN_PARAM_INV         #language en-US "%H%s%N: Invalid argument - '%H%s%N'\r\n"\r
#string STR_GEN_NO_DRIVER_BOOT    #language en-US "%H%s%N: Driver or Boot must be selected.\r\n"\r
#string STR_GEN_BOOT_ONLY         #language en-US "%H%s%N: Boot must be selected for hot key options.\r\n"\r
#string STR_GEN_TOO_FEW           #language en-US "%H%s%N: Too few arguments.\r\n"\r
#string STR_GEN_TOO_MANY          #language en-US "%H%s%N: Too many arguments\r\n"\r
#string STR_GEN_FILE_OPEN_FAIL    #language en-US "%H%s%N: Cannot open file - '%H%s%N'\r\n"\r
#string STR_GEN_FIND_FAIL         #language en-US "%H%s%N: File not found - '%H%s%N'\r\n"\r
#string STR_GEN_OUT_MEM           #language en-US "%H%s%N: Memory allocation was not successful.\r\n"\r
#string STR_BCFG_WRITE_FAIL       #language en-US "%H%s%N: Unable to write to '%H%s%N'\r\n"\r
#string STR_BCFG_READ_FAIL        #language en-US "%H%s%N: Unable to read from '%H%s%N'\r\n"\r
#string STR_BCFG_VAR_CORRUPT      #language en-US "%H%s%N: Variable '%H%s%N' corrupt.\r\n"\r
#string STR_BCFG_HANDLE           #language en-US "%H%s%N: The handle [%H%02x%N] does not have DevicePath.\r\n"\r
#string STR_BCFG_FILE             #language en-US "%H%s%N: The file '%H%s%N' matches multiple files.\r\n"\r
#string STR_BCFG_FILE_OPEN        #language en-US "%H%s%N: The file '%H%s%N' did not open.\r\n"\r
#string STR_BCFG_FILE_DP          #language en-US "%H%s%N: The file '%H%s%N' could not convert to DevPath.\r\n"\r
#string STR_BCFG_TARGET_NF        #language en-US "%H%s%N: Could not find unused target index.\r\n"\r
#string STR_BCFG_TARGET           #language en-US "Target = %04x.\r\n"\r
#string STR_BCFG_SET_VAR_FAIL     #language en-US "%H%s%N: Unable to set %H%s%N\r\n"\r
#string STR_BCFG_VAR_NO_NUM       #language en-US "%H%s%N: Cannot create Key#### variable: All the numbers from 0x0000 - 0xFFFF have been used.\r\n"\r
#string STR_BCFG_NUMB_RANGE       #language en-US "%H%s%N: Numbers must be under %d.\r\n"\r
#string STR_BCFG_NONE             #language en-US "No options found.\r\n"\r
\r
#string STR_BCFG_LOAD_OPTIONS     #language en-US "Option: %B%02x%N. Variable: %B%-11s%N\r\n"\r
                                                  "  Desc    - %s\r\n"\r
                                                  "  DevPath - %s\r\n"\r
                                                  "  Optional- %c\r\n"\r
#string STR_GET_HELP_BCFG         #language en-US ""\r
".TH bcfg 0 "configure boot and driver"\r\n"\r
".SH NAME\r\n"\r
"Manages the boot and driver options that are stored in NVRAM.\r\n"\r
".SH SYNOPSIS\r\n"\r
" \r\n"\r
"BCFG driver|boot [dump [-v]] [add # file "desc"] [addp # file "desc"] \r\n"\r
"                 [addh # handle "desc"] [rm #] [mv # #] \r\n"\r
"                 [-opt # [[filename]|["data"]] | \r\n"\r
"                         [KeyData <ScanCode UnicodeChar>]]\r\n"\r
".SH OPTIONS\r\n"\r
" \r\n"\r
"  -v          - Displays verbose information about options, including the optional\r\n"\r
"                data.\r\n"\r
"  -opt        - Displays or modifies the optional data associated with a \r\n"\r
"                driver or boot option. This parameter is followed by the file name of the\r\n"\r
"                file that contains the binary data to be associated with the\r\n"\r
"                driver or boot option optional data, or the quote\r\n"\r
"                delimited data to be associated with the driver or\r\n"\r
"                boot option optional data.\r\n"\r
"  driver      - Displays or modifies the driver option list.\r\n"\r
"  boot        - Displays or modifies the boot option list.\r\n"\r
"  dump        - Displays the option list.\r\n"\r
"  add         - Adds an option. The # is the number of options to add in\r\n"\r
"                hexadecimal format. The file name is the name of the UEFI application/driver for\r\n"\r
"                the option. The quoted parameter is the description of the\r\n"\r
"                option to be added.\r\n"\r
"  addh        - Adds an option that refers to the driver specified by a handle.\r\n"\r
"                The # is the number of options to add, in hexadecimal format. The\r\n"\r
"                handle is the driver handle, in hexadecimal format. The device path\r\n"\r
"                for the option is retrieved from the handle. The quoted\r\n"\r
"                parameter is the description of the option to be added.\r\n"\r
"  addp        - Adds an option that refers to a specific file. Only the portion\r\n"\r
"                of the device path starting with the hard drive partition is\r\n"\r
"                placed in the option. The # is the number of options to add,\r\n"\r
"                in hexadecimal format. The quoted parameter is the description of the\r\n"\r
"                option being added.\r\n"\r
"  rm          - Removes an option. The parameter lists the number of the options\r\n"\r
"                to remove in hexadecimal format.\r\n"\r
"  mv          - Moves an option. The first numeric parameter is the number of\r\n"\r
"                the option to move in hexadecimal format. The second numeric parameter\r\n"\r
"                is the new number of the option to be moved.\r\n"\r
"  KeyData     - Specifies the packed value associated with a hot-key.\r\n"\r
"  ScanCode    - Specifies the UEFI-defined scan code portion of the\r\n"\r
"                EFI_INPUT_KEY instruction. This value is directly associated\r\n"\r
"                with the preceding KeyData value. When one instance of this\r\n"\r
"                parameter has a non-zero value, the paired UnicodeChar value\r\n"\r
"                will have a zero-based value.\r\n"\r
"  UnicodeChar - Specifies the Unicode value for the character associated with\r\n"\r
"                the preceding KeyData value. When one instance of this\r\n"\r
"                parameter has a non-zero value, the paired ScanCode value\r\n"\r
"                will have a zero-based value.\r\n"\r
".SH DESCRIPTION\r\n"\r
" \r\n"\r
"NOTES:\r\n"\r
"  1. This command manages the boot and driver options stored in NVRAM.\r\n"\r
"  2. Use the dump option to display Boot#### or Driver#### environment variables.\r\n"\r
"  3. Use the add option to add a new Boot#### or Driver#### \r\n"\r
"     environment variable.\r\n"\r
"  4. Use the rm option to delete a Boot#### or Driver#### \r\n"\r
"     environment variable, and then the mv option to reorder\r\n"\r
"     the Boot#### and Driver#### environment variables.\r\n"\r
"  5. The add, rm, and mv options also update the BootOrder or DriverOrder\r\n"\r
"     environment variables, as appropriate.\r\n"\r
".SH EXAMPLES\r\n"\r
" \r\n"\r
"EXAMPLES:\r\n"\r
"  * To display driver options:\r\n"\r
"    Shell> bcfg driver dump\r\n"\r
" \r\n"\r
"  * To display boot options:\r\n"\r
"    Shell> bcfg boot dump\r\n"\r
" \r\n"\r
"  * To display verbose information about boot options:\r\n"\r
"    Shell> bcfg boot dump -v\r\n"\r
" \r\n"\r
"  * To add a driver option #5:\r\n"\r
"    Shell> bcfg driver add 5 mydriver.efi "My Driver"\r\n"\r
" \r\n"\r
"  * To add a boot option #3:\r\n"\r
"    Shell> bcfg boot add 3 osloader.efi "My OS"\r\n"\r
" \r\n"\r
"  * To remove boot option #3:\r\n"\r
"    Shell> bcfg boot rm 3\r\n"\r
" \r\n"\r
"  * To move boot option #3 to boot option #7:\r\n"\r
"    Shell> bcfg boot mv 3 7\r\n"\r
" \r\n"\r
"  * To assign a CTRL-B hot-key to boot option #3:\r\n"\r
"    Shell> bcfg boot -opt 3 0x40000200 0 0x42\r\n"\r
".SH RETURNVALUES\r\n"\r
" \r\n"\r
"RETURN VALUES:\r\n"\r
"  SHELL_SUCCESS             The action was completed as requested.\r\n"\r
"  SHELL_NOT_FOUND           The requested option was not found.\r\n"\r
"  SHELL_INVALID_PARAMETER   One of the passed-in parameters was incorrectly\r\n"\r
"                            formatted or its value was out of bounds.\r\n"\r
"  SHELL_UNSUPPORTED         The action as requested was unsupported.\r\n"\r
"  SHELL_SECURITY_VIOLATION  This function was not performed due to a security\r\n"\r
"                            violation.\r\n"\r
"  SHELL_OUT_OF_RESOURCES    There was insufficient free space for the request\r\n"\r
"                            to be completed.\r\n"\r
\r
Commit	Line	Data
e329f98b JJ	1	// /**\r
	2	//\r
	3	// (C) Copyright 2014-2015 Hewlett-Packard Development Company, L.P.<BR>\r
d653d806	4	// Copyright (c) 2010 - 2016, Intel Corporation. All rights reserved.<BR>\r
e329f98b JJ	5	// This program and the accompanying materials\r
	6	// are licensed and made available under the terms and conditions of the BSD License\r
	7	// which accompanies this distribution. The full text of the license may be found at\r
	8	// http://opensource.org/licenses/bsd-license.php\r
	9	//\r
	10	// THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
	11	// WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
	12	//\r
	13	// Module Name:\r
	14	//\r
	15	// UefiBcfgCommandsLib.uni\r
	16	//\r
	17	// Abstract:\r
	18	//\r
	19	// String definitions for UEFI Shell 2.0 BCFG command\r
	20	//\r
	21	//\r
	22	// **/\r
	23	\r
	24	/=#\r
	25	\r
	26	#langdef en-US "english"\r
	27	\r
	28	#string STR_GEN_NO_MEM #language en-US "%H%s%N: Memory is not available.\r\n"\r
	29	#string STR_GEN_PROBLEM #language en-US "%H%s%N: Unknown flag - '%H%s%N'\r\n"\r
e329f98b JJ	30	#string STR_GEN_NO_VALUE #language en-US "%H%s%N: Missing argument for flag - '%H%s%N'\r\n"\r
	31	#string STR_GEN_PARAM_INV #language en-US "%H%s%N: Invalid argument - '%H%s%N'\r\n"\r
	32	#string STR_GEN_NO_DRIVER_BOOT #language en-US "%H%s%N: Driver or Boot must be selected.\r\n"\r
	33	#string STR_GEN_BOOT_ONLY #language en-US "%H%s%N: Boot must be selected for hot key options.\r\n"\r
	34	#string STR_GEN_TOO_FEW #language en-US "%H%s%N: Too few arguments.\r\n"\r
d653d806	35	#string STR_GEN_TOO_MANY #language en-US "%H%s%N: Too many arguments\r\n"\r
e329f98b JJ	36	#string STR_GEN_FILE_OPEN_FAIL #language en-US "%H%s%N: Cannot open file - '%H%s%N'\r\n"\r
	37	#string STR_GEN_FIND_FAIL #language en-US "%H%s%N: File not found - '%H%s%N'\r\n"\r
	38	#string STR_GEN_OUT_MEM #language en-US "%H%s%N: Memory allocation was not successful.\r\n"\r
	39	#string STR_BCFG_WRITE_FAIL #language en-US "%H%s%N: Unable to write to '%H%s%N'\r\n"\r
	40	#string STR_BCFG_READ_FAIL #language en-US "%H%s%N: Unable to read from '%H%s%N'\r\n"\r
e5945ef7	41	#string STR_BCFG_VAR_CORRUPT #language en-US "%H%s%N: Variable '%H%s%N' corrupt.\r\n"\r
e329f98b JJ	42	#string STR_BCFG_HANDLE #language en-US "%H%s%N: The handle [%H%02x%N] does not have DevicePath.\r\n"\r
	43	#string STR_BCFG_FILE #language en-US "%H%s%N: The file '%H%s%N' matches multiple files.\r\n"\r
	44	#string STR_BCFG_FILE_OPEN #language en-US "%H%s%N: The file '%H%s%N' did not open.\r\n"\r
	45	#string STR_BCFG_FILE_DP #language en-US "%H%s%N: The file '%H%s%N' could not convert to DevPath.\r\n"\r
	46	#string STR_BCFG_TARGET_NF #language en-US "%H%s%N: Could not find unused target index.\r\n"\r
	47	#string STR_BCFG_TARGET #language en-US "Target = %04x.\r\n"\r
	48	#string STR_BCFG_SET_VAR_FAIL #language en-US "%H%s%N: Unable to set %H%s%N\r\n"\r
	49	#string STR_BCFG_VAR_NO_NUM #language en-US "%H%s%N: Cannot create Key#### variable: All the numbers from 0x0000 - 0xFFFF have been used.\r\n"\r
	50	#string STR_BCFG_NUMB_RANGE #language en-US "%H%s%N: Numbers must be under %d.\r\n"\r
	51	#string STR_BCFG_NONE #language en-US "No options found.\r\n"\r
	52	\r
e329f98b JJ	53	#string STR_BCFG_LOAD_OPTIONS #language en-US "Option: %B%02x%N. Variable: %B%-11s%N\r\n"\r
	54	" Desc - %s\r\n"\r
	55	" DevPath - %s\r\n"\r
	56	" Optional- %c\r\n"\r
	57	#string STR_GET_HELP_BCFG #language en-US ""\r
	58	".TH bcfg 0 "configure boot and driver"\r\n"\r
	59	".SH NAME\r\n"\r
	60	"Manages the boot and driver options that are stored in NVRAM.\r\n"\r
	61	".SH SYNOPSIS\r\n"\r
	62	" \r\n"\r
	63	"BCFG driver\|boot [dump [-v]] [add # file "desc"] [addp # file "desc"] \r\n"\r
	64	" [addh # handle "desc"] [rm #] [mv # #] \r\n"\r
	65	" [-opt # [[filename]\|["data"]] \| \r\n"\r
	66	" [KeyData <ScanCode UnicodeChar>]]\r\n"\r
	67	".SH OPTIONS\r\n"\r
	68	" \r\n"\r
	69	" -v - Displays verbose information about options, including the optional\r\n"\r
	70	" data.\r\n"\r
	71	" -opt - Displays or modifies the optional data associated with a \r\n"\r
	72	" driver or boot option. This parameter is followed by the file name of the\r\n"\r
	73	" file that contains the binary data to be associated with the\r\n"\r
	74	" driver or boot option optional data, or the quote\r\n"\r
	75	" delimited data to be associated with the driver or\r\n"\r
	76	" boot option optional data.\r\n"\r
	77	" driver - Displays or modifies the driver option list.\r\n"\r
	78	" boot - Displays or modifies the boot option list.\r\n"\r
	79	" dump - Displays the option list.\r\n"\r
	80	" add - Adds an option. The # is the number of options to add in\r\n"\r
	81	" hexadecimal format. The file name is the name of the UEFI application/driver for\r\n"\r
	82	" the option. The quoted parameter is the description of the\r\n"\r
	83	" option to be added.\r\n"\r
	84	" addh - Adds an option that refers to the driver specified by a handle.\r\n"\r
	85	" The # is the number of options to add, in hexadecimal format. The\r\n"\r
	86	" handle is the driver handle, in hexadecimal format. The device path\r\n"\r
	87	" for the option is retrieved from the handle. The quoted\r\n"\r
	88	" parameter is the description of the option to be added.\r\n"\r
	89	" addp - Adds an option that refers to a specific file. Only the portion\r\n"\r
	90	" of the device path starting with the hard drive partition is\r\n"\r
	91	" placed in the option. The # is the number of options to add,\r\n"\r
	92	" in hexadecimal format. The quoted parameter is the description of the\r\n"\r
	93	" option being added.\r\n"\r
	94	" rm - Removes an option. The parameter lists the number of the options\r\n"\r
	95	" to remove in hexadecimal format.\r\n"\r
	96	" mv - Moves an option. The first numeric parameter is the number of\r\n"\r
	97	" the option to move in hexadecimal format. The second numeric parameter\r\n"\r
	98	" is the new number of the option to be moved.\r\n"\r
	99	" KeyData - Specifies the packed value associated with a hot-key.\r\n"\r
	100	" ScanCode - Specifies the UEFI-defined scan code portion of the\r\n"\r
	101	" EFI_INPUT_KEY instruction. This value is directly associated\r\n"\r
	102	" with the preceding KeyData value. When one instance of this\r\n"\r
	103	" parameter has a non-zero value, the paired UnicodeChar value\r\n"\r
	104	" will have a zero-based value.\r\n"\r
	105	" UnicodeChar - Specifies the Unicode value for the character associated with\r\n"\r
	106	" the preceding KeyData value. When one instance of this\r\n"\r
	107	" parameter has a non-zero value, the paired ScanCode value\r\n"\r
	108	" will have a zero-based value.\r\n"\r
	109	".SH DESCRIPTION\r\n"\r
	110	" \r\n"\r
	111	"NOTES:\r\n"\r
	112	" 1. This command manages the boot and driver options stored in NVRAM.\r\n"\r
	113	" 2. Use the dump option to display Boot#### or Driver#### environment variables.\r\n"\r
	114	" 3. Use the add option to add a new Boot#### or Driver#### \r\n"\r
	115	" environment variable.\r\n"\r
	116	" 4. Use the rm option to delete a Boot#### or Driver#### \r\n"\r
117	" environment variable, and then the mv option to reorder\r\n"\r
118	" the Boot#### and Driver#### environment variables.\r\n"\r
119	" 5. The add, rm, and mv options also update the BootOrder or DriverOrder\r\n"\r
120	" environment variables, as appropriate.\r\n"\r
121	".SH EXAMPLES\r\n"\r
122	" \r\n"\r
123	"EXAMPLES:\r\n"\r
124	" * To display driver options:\r\n"\r
125	" Shell> bcfg driver dump\r\n"\r
126	" \r\n"\r
127	" * To display boot options:\r\n"\r
128	" Shell> bcfg boot dump\r\n"\r
129	" \r\n"\r
130	" * To display verbose information about boot options:\r\n"\r
131	" Shell> bcfg boot dump -v\r\n"\r
132	" \r\n"\r
133	" * To add a driver option #5:\r\n"\r
134	" Shell> bcfg driver add 5 mydriver.efi "My Driver"\r\n"\r
135	" \r\n"\r
136	" * To add a boot option #3:\r\n"\r
137	" Shell> bcfg boot add 3 osloader.efi "My OS"\r\n"\r
138	" \r\n"\r
139	" * To remove boot option #3:\r\n"\r
140	" Shell> bcfg boot rm 3\r\n"\r
141	" \r\n"\r
142	" * To move boot option #3 to boot option #7:\r\n"\r
143	" Shell> bcfg boot mv 3 7\r\n"\r
144	" \r\n"\r
145	" * To assign a CTRL-B hot-key to boot option #3:\r\n"\r
146	" Shell> bcfg boot -opt 3 0x40000200 0 0x42\r\n"\r
147	".SH RETURNVALUES\r\n"\r
148	" \r\n"\r
149	"RETURN VALUES:\r\n"\r
150	" SHELL_SUCCESS The action was completed as requested.\r\n"\r
151	" SHELL_NOT_FOUND The requested option was not found.\r\n"\r
152	" SHELL_INVALID_PARAMETER One of the passed-in parameters was incorrectly\r\n"\r
153	" formatted or its value was out of bounds.\r\n"\r
154	" SHELL_UNSUPPORTED The action as requested was unsupported.\r\n"\r
155	" SHELL_SECURITY_VIOLATION This function was not performed due to a security\r\n"\r
156	" violation.\r\n"\r
157	" SHELL_OUT_OF_RESOURCES There was insufficient free space for the request\r\n"\r
158	" to be completed.\r\n"\r
159	\r