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