]> git.proxmox.com Git - mirror_edk2.git/blob - ShellPkg/Library/UefiShellLevel3CommandsLib/UefiShellLevel3CommandsLib.uni
ShellPkg/for: Fix potential null pointer deference
[mirror_edk2.git] / ShellPkg / Library / UefiShellLevel3CommandsLib / UefiShellLevel3CommandsLib.uni
1 // /**
2 //
3 // (C) Copyright 2016 Hewlett Packard Enterprise Development LP<BR>
4 // (C) Copyright 2013-2015 Hewlett-Packard Development Company, L.P.<BR>
5 // Copyright (c) 2009 - 2017, Intel Corporation. All rights reserved. <BR>
6 // This program and the accompanying materials
7 // are licensed and made available under the terms and conditions of the BSD License
8 // which accompanies this distribution. The full text of the license may be found at
9 // http://opensource.org/licenses/bsd-license.php
10 //
11 // THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
12 // WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
13 //
14 // Module Name:
15 //
16 // UefiShellLevel3CommandsLib.uni
17 //
18 // Abstract:
19 //
20 // String definitions for UEFI Shell 2.0 level 3 commands
21 //
22 //
23 // **/
24
25 /=#
26
27 #langdef en-US "english"
28
29 #string STR_GEN_TOO_MANY #language en-US "%H%s%N: Too many arguments\r\n"
30 #string STR_GEN_TOO_FEW #language en-US "%H%s%N: Too few arguments\r\n"
31 #string STR_GEN_PARAM_INV #language en-US "%H%s%N: Invalid argument - '%H%s%N'\r\n"
32 #string STR_GEN_PROBLEM #language en-US "%H%s%N: Unknown flag - '%H%s%N'\r\n"
33 #string STR_GEN_NO_VALUE #language en-US "%H%s%N: Missing argument for flag - '%H%s%N'\r\n"
34 #string STR_GEN_ERR_AD #language en-US "%H%s%N: Access denied.\r\n"
35 #string STR_GEN_ERR_NOT_FOUND #language en-US "%H%s%N: '%H%s%N' does not exist.\r\n"
36 #string STR_GEN_ERR_UK #language en-US "%H%s%N: Status: %r\r\n"
37 #string STR_GEN_PARAM_CON #language en-US "%H%s%N: Parameters conflict\r\n"
38 #string STR_GEN_PARAM_CONFLICT #language en-US "%H%s%N: Flags conflict with - '%H%s%N' and '%H%s%N'\r\n"
39 #string STR_GEN_FILE_OPEN_FAIL #language en-US "%H%s%N: Cannot open file - '%H%s%N'\r\n"
40 #string STR_GEN_FILE_AD #language en-US "%H%s%N: Access file error - '%H%s%N'\r\n"
41 #string STR_GEN_CRLF #language en-US "\r\n"
42 #string STR_GEN_NO_CWD #language en-US "%H%s%N: Current directory not specified\r\n"
43 #string STR_GEN_NO_FILES #language en-US "%H%s%N: No matching files were found\r\n"
44 #string STR_GEN_DIR_NF #language en-US "%H%s%N: Directory not found - '%H%s%N'\r\n"
45 #string STR_GEN_FILE_NF #language en-US "%H%s%N: File not found - '%H%s%N'\r\n"
46 #string STR_GEN_IS_DIR #language en-US "%H%s%N: '%H%s%N' is a directory\r\n"
47 #string STR_GEN_SFO_HEADER #language en-US "ShellCommand,"%s"\r\n"
48 #string STR_NO_SCRIPT #language en-US "The command '%H%s%N' is not allowed outside of a script\r\n"
49
50 #string STR_TYP_ERROR #language en-US "%H%s%N: Operation was not successful on '%H%s%N'\r\n"
51
52 #string STR_TOUCH_ERROR #language en-US "%H%s%N: Operation was not successful on '%H%s%N'\r\n"
53
54 #string STR_VER_OUTPUT_SHELL #language en-US "UEFI %s Shell v%d.%d\r\n"
55 #string STR_VER_OUTPUT_SIMPLE #language en-US "%d.%d\r\n"
56 #string STR_VER_OUTPUT_UEFI #language en-US "UEFI v%d.%02d (%s, 0x%08x)\r\n"
57 #string STR_VER_OUTPUT_SUPPLIER #language en-US "%s\r\n"
58
59 #string STR_ECHO_ON #language en-US "Echo is on.\r\n"
60 #string STR_ECHO_OFF #language en-US "Echo is off.\r\n"
61
62 #string STR_PAUSE_PROMPT #language en-US "Enter 'q' to quit, any other key to continue:\r\n"
63
64 #string STR_HELP_NF #language en-US "No help could be found for command '%B%s%N'.\r\n"
65 #string STR_HELP_INV #language en-US "The help data for command '%B%s%N' was incorrect format.\r\n"
66 #string STR_HELP_SC_HEADER #language en-US "Character Description\r\n"
67 "--------- ---------------------------------------------- \r\n"
68 #string STR_HELP_SC_DATA #language en-US "<newline> Ends a command line.\r\n"
69 "<space> Ends an argument, if it is not in a quotation.\r\n"
70 "# Starts a comment.\r\n"
71 "> Used for output redirection.\r\n"
72 "< Used for input redirection.\r\n"
73 "| Used for pipe command support.\r\n"
74 "% Used to delimit a variable or an argument.\r\n"
75 "\" Used to delimit a quotation.\r\n"
76 "^ Prevents the next character from being\r\n"
77 " interpreted as having special meaning.\r\n"
78 " Can be used inside quoted strings.\r\n"
79 "*, ?, [, ] Wildcards to specify multiple similar file names.\r\n"
80 #string STR_HELP_COMMAND #language en-US "%H%-14s%N- %s\r\n"
81 #string STR_HELP_FOOTER #language en-US "%N\r\nHelp usage:help [%Hcmd%N|%Hpattern%N|%Hspecial%N] [%H-usage%N] [%H-verbose%N] [%H-section name%N][%H-b%N]\r\n"
82
83 #string STR_HELP_PAGE_COMMAND #language en-US "%N%s\r\n"
84
85 #string STR_ALIAS_OUTPUT #language en-US "%1c %10s:%s\r\n"
86
87 #string STR_GET_MTC_OUTPUT #language en-US "%016Lx\r\n"
88 #string STR_CLS_OUTPUT_SFO #language en-US "ConOutAttribInfo,"%d","%d","%d"\r\n"
89
90 #string STR_GET_HELP_HELP #language en-US ""
91 ".TH help 0 "Displays help information from the UEFI Shell."\r\n"
92 ".SH NAME\r\n"
93 "Displays the UEFI Shell command list or verbose command help.\r\n"
94 ".SH SYNOPSIS\r\n"
95 " \r\n"
96 "HELP [cmd | pattern | special] [-usage] [-verbose] [-section sectionname][-b]\r\n"
97 ".SH OPTIONS\r\n"
98 " \r\n"
99 " -usage - Displays the usage information for the command. The same as\r\n"
100 " specifying "-section NAME" and "-section SYNOPSIS" \r\n"
101 " -section - Displays the specified section of the help information.\r\n"
102 " -b - Displays one page on screen and allows user to continue\r\n"
103 " to next page\r\n"
104 " cmd - Specifies a command to display help about.\r\n"
105 " pattern - Specifies a pattern which describes the commands to be displayed.\r\n"
106 " special - Displays a list of the special characters used in the shell\r\n"
107 " command line.\r\n"
108 " sectionname - Specifies a section name. Supported options are:\r\n"
109 " - NAME\r\n"
110 " - SYNOPSIS\r\n"
111 " - OPTIONS\r\n"
112 " - DESCRIPTION\r\n"
113 " - EXAMPLES\r\n"
114 " - RETURNVALUES\r\n"
115 ".SH DESCRIPTION\r\n"
116 " \r\n"
117 "NOTES:\r\n"
118 " 1. The HELP command displays information about one or more shell commands.\r\n"
119 " 2. If no other options are specified, each command will be displayed along\r\n"
120 " with a brief description of its function.\r\n"
121 " 3. If -verbose is specified, then display all help information for the\r\n"
122 " specified commands.\r\n"
123 " 4. If -section is specified, only the help section specified will be\r\n"
124 " displayed.\r\n"
125 " 5. If -usage is specified, then the command, a brief description\r\n"
126 " and the usage will be displayed.\r\n"
127 " 6. The help text is gathered from UCS-2 text files found in the directory\r\n"
128 " where the shell or shell command executable was located. The files have\r\n"
129 " the name commandname.\r\n"
130 ".SH EXAMPLES\r\n"
131 " \r\n"
132 "EXAMPLES:\r\n"
133 " * To display the list of commands in the UEFI Shell and break after one\r\n"
134 " screen:\r\n"
135 " Shell> help -b\r\n"
136 " \r\n"
137 " * To display help information of a Shell command - ls:\r\n"
138 " Shell> help ls\r\n"
139 " Shell> -? ls\r\n"
140 " Shell> ls -?\r\n"
141 " \r\n"
142 " * To display the list of commands that start with character 'p':\r\n"
143 " Shell> help p*\r\n"
144 ".SH RETURNVALUES\r\n"
145 " \r\n"
146 "RETURN VALUES:\r\n"
147 " 0 The help was displayed\r\n"
148 " 1 No command help was displayed\r\n"
149
150 #string STR_GET_HELP_ALIAS #language en-US ""
151 ".TH alias 0 "Handles aliases in the Shell."\r\n"
152 ".SH NAME\r\n"
153 "Displays, creates, or deletes UEFI Shell aliases.\r\n"
154 ".SH SYNOPSIS\r\n"
155 " \r\n"
156 "ALIAS [-d|-v] [alias-name] [command-name]\r\n"
157 ".SH OPTIONS\r\n"
158 " \r\n"
159 " -d - Deletes an alias. Command-name must not be specified.\r\n"
160 " -v - Makes the alias volatile.\r\n"
161 " alias-name - Specifies an alias name.\r\n"
162 " command-name - Specifies an original command's name or path.\r\n"
163 ".SH DESCRIPTION\r\n"
164 " \r\n"
165 "NOTES:\r\n"
166 " 1. This command displays, creates, or deletes aliases in the UEFI Shell\r\n"
167 " environment.\r\n"
168 " 2. An alias provides a new name for an existing UEFI Shell\r\n"
169 " command or UEFI application. Once the alias is created, it can be used\r\n"
170 " to run the command or launch the UEFI application.\r\n"
171 " 3. There are some aliases that are predefined in the UEFI Shell environment.\r\n"
172 " These aliases provide the MS-DOS and UNIX equivalent names for the file\r\n"
173 " manipulation commands.\r\n"
174 " 4. Aliases will be retained even after exiting the shell unless the -v option\r\n"
175 " is specified. If -v is specified then the alias will not be valid after\r\n"
176 " leaving the shell.\r\n"
177 ".SH EXAMPLES\r\n"
178 " \r\n"
179 "EXAMPLES:\r\n"
180 " * To display all aliases in the UEFI Shell environment:\r\n"
181 " Shell> alias\r\n"
182 " \r\n"
183 " * To create an alias in the UEFI Shell environment:\r\n"
184 " Shell> alias shutdown "reset -s" \r\n"
185 " \r\n"
186 " * To delete an alias in the UEFI Shell environment:\r\n"
187 " Shell> alias -d shutdown\r\n"
188 " \r\n"
189 " * To add a volatile alias in the current UEFI environment, which has a star *\r\n"
190 " at the line head. This volatile alias will disappear at next boot.\r\n"
191 " Shell> alias -v fs0 floppy\r\n"
192 ".SH RETURNVALUES\r\n"
193 " \r\n"
194 "RETURN VALUES:\r\n"
195 " SHELL_SUCCESS The action was completed as requested.\r\n"
196 " SHELL_INVALID_PARAMETER One of the passed-in parameters was incorrectly\r\n"
197 " formatted or its value was out of bounds.\r\n"
198 " SHELL_OUT_OF_RESOURCES A request to set a variable in a non-volatile\r\n"
199 " fashion could not be completed. The resulting\r\n"
200 " non-volatile request has been converted into\r\n"
201 " a volatile request.\r\n"
202 " SHELL_SECURITY_VIOLATION This function was not performed due to a security\r\n"
203 " violation.\r\n"
204
205 #string STR_GET_HELP_CLS #language en-US ""
206 ".TH cls 0 "clear screen"\r\n"
207 ".SH NAME\r\n"
208 "Clears the console output and optionally changes the background and foreground color.\r\n"
209 ".SH SYNOPSIS\r\n"
210 " \r\n"
211 "CLS [background] [foreground] | [-sfo]\r\n"
212 ".SH OPTIONS\r\n"
213 " \r\n"
214 " background - Sets a new background color:\r\n"
215 " 0 - Black\r\n"
216 " 1 - Blue\r\n"
217 " 2 - Green\r\n"
218 " 3 - Cyan\r\n"
219 " 4 - Red\r\n"
220 " 5 - Magenta\r\n"
221 " 6 - Yellow\r\n"
222 " 7 - Light gray\r\n"
223 " foreground - Sets a new foreground color:\r\n"
224 " 0 - Black\r\n"
225 " 1 - Blue\r\n"
226 " 2 - Green\r\n"
227 " 3 - Cyan\r\n"
228 " 4 - Red\r\n"
229 " 5 - Magenta\r\n"
230 " 6 - Yellow\r\n"
231 " 7 - Light gray\r\n"
232 " 8 - Dark gray\r\n"
233 " 9 - Light blue\r\n"
234 " 10 - Light green\r\n"
235 " 11 - Light cyan\r\n"
236 " 12 - Light red\r\n"
237 " 13 - Light magenta\r\n"
238 " 14 - Yellow\r\n"
239 " 15 - White\r\n"
240 " -sfo - Displays current console color settings in Standard Format\r\n"
241 " Output.\r\n"
242 ".SH DESCRIPTION\r\n"
243 " \r\n"
244 "NOTES:\r\n"
245 " 1. This command clears the standard output device with an optional\r\n"
246 " background and foreground color attribute.\r\n"
247 " 2. If background color is not specified, or if background and foreground\r\n"
248 " colors are not specified, then the colors do not change.\r\n"
249 " 3. When -sfo flag is used, console output is not cleared and instead it\r\n"
250 " displays current console foreground and background attribute settings.\r\n"
251 ".SH EXAMPLES\r\n"
252 " \r\n"
253 "EXAMPLES:\r\n"
254 " * To clear standard output without changing the background or foreground\r\n"
255 " color:\r\n"
256 " fs0:\> cls\r\n"
257 " \r\n"
258 " * To clear standard output and change the background color to cyan:\r\n"
259 " fs0:\> cls 3\r\n"
260 " \r\n"
261 " * To clear standard output and change the background to black and foreground\r\n"
262 " to white:\r\n"
263 " fs0:\> cls 0 15\r\n"
264 ".SH RETURNVALUES\r\n"
265 " \r\n"
266 "RETURN VALUES:\r\n"
267 " SHELL_SUCCESS The action was completed as requested.\r\n"
268 " SHELL_INVALID_PARAMETER One of the passed-in parameters was incorrectly\r\n"
269 " formatted or its value was out of bounds.\r\n"
270 " SHELL_SECURITY_VIOLATION This function was not performed due to a security\r\n"
271 " violation.\r\n"
272 " SHELL_NOT_FOUND The requested file was not found.\r\n"
273
274 #string STR_GET_HELP_ECHO #language en-US ""
275 ".TH echo 0 "display text or control text output"\r\n"
276 ".SH NAME\r\n"
277 "Controls script file command echoing or displays a message.\r\n"
278 ".SH SYNOPSIS\r\n"
279 " \r\n"
280 "ECHO [-on|-off]\r\n"
281 "ECHO [message]\r\n"
282 ".SH OPTIONS\r\n"
283 " \r\n"
284 " -on - Enables display when reading commands from script files.\r\n"
285 " -off - Disables display when reading commands from script files.\r\n"
286 " message - Specifies a message to display.\r\n"
287 ".SH DESCRIPTION\r\n"
288 " \r\n"
289 "NOTES:\r\n"
290 " 1. The first form of this command controls whether script commands are\r\n"
291 " displayed as they are read from the script file. If no argument is given,\r\n"
292 " the current "on" or "off" status is displayed.\r\n"
293 " 2. The second form prints the given message to the display.\r\n"
294 ".SH EXAMPLES\r\n"
295 " \r\n"
296 "EXAMPLES:\r\n"
297 " * To display a message string of 'Hello World':\r\n"
298 " fs0:\> echo Hello World\r\n"
299 " \r\n"
300 " * To turn command echoing on:\r\n"
301 " fs0:\> echo -on\r\n"
302 " \r\n"
303 " * To execute HelloWorld.nsh, and display when reading lines from the script\r\n"
304 " file:\r\n"
305 " fs0:\> HelloWorld.nsh\r\n"
306 " +HelloWorld.nsh> echo Hello World\r\n"
307 " \r\n"
308 " * To turn command echoing off:\r\n"
309 " fs0:\> echo -off\r\n"
310 " \r\n"
311 " * To display the current echo setting:\r\n"
312 " fs0:\> echo\r\n"
313 ".SH RETURNVALUES\r\n"
314 " \r\n"
315 "RETURN VALUES:\r\n"
316 " SHELL_SUCCESS The action was completed as requested.\r\n"
317 " SHELL_SECURITY_VIOLATION This function was not performed due to a security\r\n"
318 " violation.\r\n"
319
320 #string STR_GET_HELP_GETMTC #language en-US ""
321 ".TH getmtc 0 "gets the MTC count"\r\n"
322 ".SH NAME\r\n"
323 "Gets the MTC from BootServices and displays it.\r\n"
324 ".SH SYNOPSIS\r\n"
325 " \r\n"
326 "GETMTC\r\n"
327 ".SH DESCRIPTION\r\n"
328 " \r\n"
329 "NOTES:\r\n"
330 " 1. This command displays the current monotonic counter value. The lower 32\r\n"
331 " bits increment every time this command is executed. Every time the system\r\n"
332 " is reset, the upper 32 bits will be incremented, and the lower 32 bits\r\n"
333 " will be reset to 0.\r\n"
334 ".SH EXAMPLES\r\n"
335 " \r\n"
336 "EXAMPLES:\r\n"
337 " * To display the current monotonic counter value:\r\n"
338 " fs0:\> getmtc\r\n"
339 ".SH RETURNVALUES\r\n"
340 " \r\n"
341 "RETURN VALUES:\r\n"
342 " SHELL_SUCCESS The action was completed as requested.\r\n"
343 " SHELL_DEVICE_ERROR The underlying device was not working correctly.\r\n"
344 " SHELL_SECURITY_VIOLATION This function was not performed due to a security\r\n"
345 " violation.\r\n"
346
347 #string STR_GET_HELP_PAUSE #language en-US ""
348 ".TH pause 0 "pauses scripts"\r\n"
349 ".SH NAME\r\n"
350 "Pauses a script and waits for an operator to press a key.\r\n"
351 ".SH SYNOPSIS\r\n"
352 " \r\n"
353 "PAUSE [-q]\r\n"
354 ".SH OPTIONS\r\n"
355 " \r\n"
356 " -q - Does not display a test output prompt.\r\n"
357 ".SH DESCRIPTION\r\n"
358 " \r\n"
359 "NOTES:\r\n"
360 " 1. The PAUSE command prints a message to the display, then suspends script\r\n"
361 " file execution, and waits for keyboard input. Pressing any key resumes\r\n"
362 " execution, except for q or Q. If either q or Q is pressed, script\r\n"
363 " processing terminates; otherwise, execution continues with the next line\r\n"
364 " after the pause command.\r\n"
365 " 2. The PAUSE command is available only in scripts. Switch -q can hide the\r\n"
366 " message and it's optional.\r\n"
367 ".SH EXAMPLES\r\n"
368 " \r\n"
369 "EXAMPLES:\r\n"
370 " * Following script is a sample of 'pause' command:\r\n"
371 " fs0:\> type pause.nsh\r\n"
372 " #\r\n"
373 " # Example script for 'pause' command\r\n"
374 " #\r\n"
375 " echo pause.nsh begin..\r\n"
376 " date\r\n"
377 " time\r\n"
378 " pause\r\n"
379 " echo pause.nsh done.\r\n"
380 " \r\n"
381 " * To execute the script with echo on:\r\n"
382 " fs0:\> pause.nsh\r\n"
383 " +pause.nsh> echo pause.nsh begin..\r\n"
384 " pause.nsh begin..\r\n"
385 " +pause.nsh> date\r\n"
386 " 06/19/2001\r\n"
387 " +pause.nsh> time\r\n"
388 " 00:51:45\r\n"
389 " +pause.nsh> pause\r\n"
390 " Enter 'q' to quit, or any other key to continue:\r\n"
391 " +pause.nsh> echo pause.nsh done.\r\n"
392 " pause.nsh done.\r\n"
393 " \r\n"
394 " * To execute the script with echo off:\r\n"
395 " fs0:\> echo -off\r\n"
396 " fs0:\> pause.nsh\r\n"
397 " pause.nsh begin..\r\n"
398 " 06/19/2001\r\n"
399 " 00:52:50\r\n"
400 " Enter 'q' to quit, or any other key to continue: q\r\n"
401 " fs0:\>\r\n"
402
403 #string STR_GET_HELP_TOUCH #language en-US ""
404 ".TH touch 0 "Touch a file to update a directory"\r\n"
405 ".SH NAME\r\n"
406 "Updates the filename timestamp with the current system date and time.\r\n"
407 ".SH SYNOPSIS\r\n"
408 " \r\n"
409 "TOUCH [-r] file [file ...]\r\n"
410 ".SH OPTIONS\r\n"
411 " \r\n"
412 " -r - Sets the update as recurse into subdirectories.\r\n"
413 " file - Specifies the name or pattern of the file or directory. There can be multiple \r\n"
414 " files on the command-line.\r\n"
415 ".SH DESCRIPTION\r\n"
416 " \r\n"
417 "NOTES:\r\n"
418 " 1. This command updates to the current time and date the time and date on\r\n"
419 " the file that is specified by the file parameter.\r\n"
420 " 2. If multiple files are specified on the command line, it will continue\r\n"
421 " processing. It will touch the files one by one and errors will be\r\n"
422 " ignored.\r\n"
423 " 3. TOUCH cannot change the time and date of read-only files and directories.\r\n"
424 ".SH EXAMPLES\r\n"
425 " \r\n"
426 "EXAMPLES:\r\n"
427 " * To update the timestamp of a specific file:\r\n"
428 " fs0:\> touch for.nsh\r\n"
429 " \r\n"
430 " * To touch a directory recursively:\r\n"
431 " fs0:\> touch -r efi1.1\r\n"
432 ".SH RETURNVALUES\r\n"
433 " \r\n"
434 "RETURN VALUES:\r\n"
435 " SHELL_SUCCESS The action was completed as requested.\r\n"
436 " SHELL_NOT_FOUND The target file or set of files were not found.\r\n"
437 " SHELL_SECURITY_VIOLATION This function was not performed due to a security\r\n"
438 " violation.\r\n"
439 " SHELL_WRITE_PROTECTED The media was write-protected or the file had a\r\n"
440 " read-only attribute associated with it.\r\n"
441
442 #string STR_GET_HELP_TYPE #language en-US ""
443 ".TH type 0 "print a file to StdOut"\r\n"
444 ".SH NAME\r\n"
445 "Sends the contents of a file to the standard output device.\r\n"
446 ".SH SYNOPSIS\r\n"
447 " \r\n"
448 "TYPE [-a|-u] file [file...]\r\n"
449 ".SH OPTIONS\r\n"
450 " \r\n"
451 " -a - Displays the file as if it is encoded as 8-bit ASCII\r\n"
452 " -u - Displays the file as if it were encoded as UCS-2 Unicode.\r\n"
453 " file - Specifies the name of the file to display.\r\n"
454 ".SH DESCRIPTION\r\n"
455 " \r\n"
456 "NOTES:\r\n"
457 " 1. This command sends the contents of a file to the standard output device.\r\n"
458 " If no options are used, then the command attempts to automatically detect\r\n"
459 " the file type. If it fails, then UCS-2 is presumed.\r\n"
460 " 2. If the -a option is specified, the file is sent to the standard output\r\n"
461 " device as a stream of ASCII characters.\r\n"
462 " 3. If the -u option is specified, the file is sent to the standard output\r\n"
463 " device as a stream of Unicode (UCS-2) characters.\r\n"
464 ".SH EXAMPLES\r\n"
465 " \r\n"
466 "EXAMPLES:\r\n"
467 " * To display a file in UCS-2 format:\r\n"
468 " fs0:\> type -u pause.nsh\r\n"
469 " \r\n"
470 " * To display a file in ASCII format:\r\n"
471 " fs0:\> type -a pause.nsh\r\n"
472 " \r\n"
473 " * To display multiple files:\r\n"
474 " fs0:\> type test.*\r\n"
475 ".SH RETURNVALUES\r\n"
476 " \r\n"
477 "RETURN VALUES:\r\n"
478 " SHELL_SUCCESS The action was completed as requested.\r\n"
479 " SHELL_INVALID_PARAMETER One of the passed in parameters was incorrectly\r\n"
480 " formatted or its value was out of bounds.\r\n"
481 " SHELL_SECURITY_VIOLATION This function was not performed due to a security\r\n"
482 " violation.\r\n"
483 " SHELL_NOT_FOUND The target file or set of files were not found.\r\n"
484
485 #string STR_GET_HELP_VER #language en-US ""
486 ".TH ver 0 "prints out version info"\r\n"
487 ".SH NAME\r\n"
488 "Displays UEFI Firmware version information.\r\n"
489 ".SH SYNOPSIS\r\n"
490 " \r\n"
491 "VER [-s|-terse]\r\n"
492 ".SH OPTIONS\r\n"
493 " \r\n"
494 " -s - Displays only the UEFI Shell version.\r\n"
495 " -terse - Displays only the first part of the data.\r\n"
496 ".SH DESCRIPTION\r\n"
497 " \r\n"
498 "NOTES:\r\n"
499 " 1. This command displays the version information for this UEFI Firmware, or\r\n"
500 " the version information for the UEFI Shell itself. The information is\r\n"
501 " retrieved through the UEFI System Table or the Shell image.\r\n"
502 " \r\n"
503 " 2. Standard format for ver output as shown below with a sample:\r\n"
504 " UEFI <support-level> Shell v<uefi-shell-version>\r\n"
505 " shell-supplier-specific-data\r\n"
506 " UEFI v<uefi-firmware-version> (<firmware vendor name>, 0x<firmware vendor\r\n"
507 " version as 32-bit hex value> <optional additional vendor version>)\r\n"
508 " #\r\n"
509 " # Sample \r\n"
510 " #\r\n"
511 " UEFI Basic Shell v2.0\r\n"
512 " Copyright 2008 by Intel(R) Corporation.\r\n"
513 " UEFI v2.31 (Intel(R) Corporation., 0x00010100)\r\n"
514 " \r\n"
515 " 3. UEFI version tag information:\r\n"
516 " <support-level>\r\n"
517 " 0 = Minimal\r\n"
518 " 1 = Scripting\r\n"
519 " 2 = Basic\r\n"
520 " 3 = Interactive\r\n"
521 " <uefi-shell-version>\r\n"
522 " Comes from the Shell specification upon which the Shell\r\n"
523 " implementation is based.\r\n"
524 " <shell-supplier-specific-data>\r\n"
525 " Build, copyright, etc.\r\n"
526 " <uefi-firmware-version>\r\n"
527 " Comes from the UEFI specification upon which the firmware\r\n"
528 " implementation is based\r\n"
529 " <firmware vendor name>\r\n"
530 " Indicates Vendor Name\r\n"
531 " <firmware vendor version>\r\n"
532 " Indicates Vendor's firmware version\r\n"
533 ".SH EXAMPLES\r\n"
534 " \r\n"
535 "EXAMPLES:\r\n"
536 " * To display UEFI Firmware version information:\r\n"
537 " fs0:\> ver\r\n"
538 " \r\n"
539 " * To display UEFI Shell version information only:\r\n"
540 " Shell> ver -s\r\n"
541 ".SH RETURNVALUES\r\n"
542 " \r\n"
543 "RETURN VALUES:\r\n"
544 " SHELL_SUCCESS The action was completed as requested.\r\n"
545