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