]>
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 - 2015, 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 | // UefiShellLevel2CommandsLib.uni\r | |
16 | //\r | |
17 | // Abstract:\r | |
18 | //\r | |
19 | // String definitions for UEFI Shell 2.0 level 2 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_NO_MEM #language en-US "%H%s%N: Memory is not available.\r\n"\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_PROBLEM_VAL #language en-US "%H%s%N: Bad value - '%H%s%N' for flag - '%H%s%N'\r\n"\r | |
34 | #string STR_GEN_ATTRIBUTE #language en-US "%H%s%N: Invalid argument - '%H-a%s%N'\r\n"\r | |
35 | #string STR_GEN_NO_VALUE #language en-US "%H%s%N: Missing argument for flag - '%H%s%N'\r\n"\r | |
36 | #string STR_GEN_ERR_AD #language en-US "%H%s%N: Access denied.\r\n"\r | |
37 | #string STR_GEN_ERR_FILE #language en-US "%H%s%N: File '%H%s%N' error - %r\r\n"\r | |
38 | #string STR_GEN_ERR_UK #language en-US "%H%s%N: Status: %r\r\n"\r | |
39 | #string STR_GEN_PARAM_CON #language en-US "%H%s%N: Parameters conflict.\r\n"\r | |
40 | #string STR_GEN_PARAM_CONFLICT #language en-US "%H%s%N: Flags conflict with - '%H%s%N' and '%H%s%N'\r\n"\r | |
41 | #string STR_GEN_FILE_OPEN_FAIL #language en-US "%H%s%N: Cannot open file - '%H%s%N'\r\n"\r | |
42 | #string STR_GEN_FILE_CLOSE_FAIL #language en-US "%H%s%N: Cannot close file - '%H%s%N'\r\n"\r | |
43 | #string STR_GEN_FILE_AD #language en-US "%H%s%N: File access error - '%H%s%N'\r\n"\r | |
44 | #string STR_GEN_FILE_NF #language en-US "%H%s%N: File not found - '%H%s%N'\r\n"\r | |
45 | #string STR_GEN_CRLF #language en-US "\r\n"\r | |
46 | #string STR_GEN_NO_CWD #language en-US "%H%s%N: Current directory not specified.\r\n"\r | |
47 | #string STR_GEN_NO_FILES #language en-US "%H%s%N: No matching files were found.\r\n"\r | |
48 | #string STR_GEN_DIR_NF #language en-US "%H%s%N: Directory not found - '%H%s%N'\r\n"\r | |
49 | #string STR_GEN_RES_OK #language en-US "- [ok]\r\n"\r | |
50 | #string STR_GEN_NOT_DIR #language en-US "%H%s%N: '%H%s%N' is not a directory.\r\n"\r | |
51 | #string STR_GEN_NOT_FILE #language en-US "%H%s%N: '%H%s%N' is not a file.\r\n"\r | |
52 | #string STR_GEN_SFO_HEADER #language en-US "ShellCommand,"%s"\r\n"\r | |
53 | #string STR_GEN_MARG_ERROR #language en-US "%H%s%N: The destination '%H%s%N' is ambiguous.\r\n"\r | |
54 | #string STR_GEN_FILE_ERROR #language en-US "%H%s%N: The destination is an existing file '%H%s%N'.\r\n"\r | |
55 | #string STR_GEN_UEFI_FUNC_ERROR #language en-US "%H%s%N: UEFI function '%H%s%N' returned an incorrect value for: %s (%x).\r\n"\r | |
56 | #string STR_GEN_UEFI_FUNC_WARN #language en-US "%H%s%N: UEFI function '%H%s%N' returned: %r\r\n"\r | |
57 | #string STR_GEN_DEST_EXIST_OVR #language en-US "Destination file already exists. Overwrite? %BY%Nes, %BN%No, %BA%Nll, %BC%Nancel "\r | |
58 | #string STR_GEN_CPY_FAIL #language en-US "%H%s%N: Copy failure: insufficient capacity on destination media.\r\n"\r | |
59 | #string STR_GEN_CPY_READ_ERROR #language en-US "%H%s%N: reading '%B%s%N': IO Error \r\n"\r | |
60 | #string STR_GEN_CPY_WRITE_ERROR #language en-US "%H%s%N: writing '%B%s%N': IO Error \r\n"\r | |
61 | #string STR_GEN_OUT_MEM #language en-US "%H%s%N: Memory allocation was not successful.\r\n"\r | |
62 | \r | |
63 | #string STR_SET_DISP #language en-US "%V%8s %N= %H%s%N\r\n"\r | |
64 | #string STR_SET_NF #language en-US "%H%s%N: Environment Variable '%H%s%N' not defined.\r\n"\r | |
65 | #string STR_SET_ND #language en-US "%H%s%N: Environment Variable '%H%s%N' could not be deleted.\r\n"\r | |
66 | #string STR_SET_ERROR_SET #language en-US "%H%s%N: Unable to set %H%s%N\r\n"\r | |
67 | \r | |
68 | #string STR_CD_PRINT #language en-US "%s\r\n"\r | |
69 | #string STR_CD_NF #language en-US "%H%s%N: No mapping found.\r\n"\r | |
70 | \r | |
71 | #string STR_MAP_NF #language en-US "%H%s%N: Cannot find mapped device - '%H%s%N'\r\n"\r | |
72 | #string STR_MAP_NOF #language en-US "%H%s%N: No mappable target found - '%H%s%N'\r\n"\r | |
73 | #string STR_MAP_SFO_MAPPINGS #language en-US "Mappings,"%s","%s","%s"\r\n"\r | |
74 | #string STR_MAP_HEADER #language en-US "%EMapping table%N\r\n"\r | |
75 | #string STR_MAP_ENTRY #language en-US "%E%10s%N %HAlias(s):%N%s\r\n %s\r\n"\r | |
76 | #string STR_MAP_ENTRY_VERBOSE #language en-US " Handle: [%H%02x%N]\r\n"\r | |
77 | " Media Type: %s\r\n"\r | |
78 | " Removable: %s\r\n"\r | |
79 | " Current Dir: %s\r\n"\r | |
80 | \r | |
81 | #string STR_ATTRIB_OUTPUT_LINE #language en-US "Attrib: %1c%1c%1c%1c%1c %s\r\n"\r | |
82 | \r | |
83 | #string STR_MAP_MEDIA_FLOPPY #language en-US "Floppy"\r | |
84 | #string STR_MAP_MEDIA_UNKNOWN #language en-US "Unknown"\r | |
85 | #string STR_MAP_MEDIA_HARDDISK #language en-US "HardDisk"\r | |
86 | #string STR_MAP_MEDIA_CDROM #language en-US "CD-Rom"\r | |
87 | \r | |
88 | #string STR_MKDIR_ALREADY #language en-US "Directory '%B%s%N' already exists.\r\n"\r | |
89 | #string STR_MKDIR_CREATEFAIL #language en-US "Directory '%B%s%N' unable to create.\r\n"\r | |
90 | \r | |
91 | #string STR_DATE_FORMAT #language en-US "%02d/%02d/%04d\r\n"\r | |
92 | #string STR_DATE_SFO_FORMAT #language en-US "Date,"%02d","%02d","%04d"\r\n"\r | |
93 | \r | |
94 | #string STR_TIME_FORMAT #language en-US "%02d:%02d:%02d (UTC%1s%02d:%02d)"\r | |
95 | #string STR_TIME_FORMAT_LOCAL #language en-US "%02d:%02d:%02d (LOCAL)"\r | |
96 | #string STR_TIME_DST0 #language en-US " DST: Not Affected\r\n"\r | |
97 | #string STR_TIME_DST1 #language en-US " DST: Affected\r\n"\r | |
98 | #string STR_TIME_DST2 #language en-US " DST: Adjusted\r\n"\r | |
99 | #string STR_TIME_DST3 #language en-US " DST: Affected and Adjusted\r\n"\r | |
100 | \r | |
101 | #string STR_TIMEZONE_M12 #language en-US "UTC-12:00, International Date Line West\r\n"\r | |
102 | #string STR_TIMEZONE_M11 #language en-US "UTC-11:00, Midway Island, Samoa\r\n"\r | |
103 | #string STR_TIMEZONE_M10 #language en-US "UTC-10:00, Hawaii\r\n"\r | |
104 | #string STR_TIMEZONE_M9 #language en-US "UTC-09:00, Alaska\r\n"\r | |
105 | #string STR_TIMEZONE_M8 #language en-US "UTC-08:00, Pacific Time(US & Canada), Tijuana, Portland\r\n"\r | |
106 | #string STR_TIMEZONE_M7 #language en-US "UTC-07:00, Arizona, Chihuahua, La Paz, Mazatlan, Mountain Time (US & Canada)\r\n"\r | |
107 | #string STR_TIMEZONE_M6 #language en-US "UTC-06:00, Central America, Central Time(US & Canada)\r\n"\r | |
108 | #string STR_TIMEZONE_M5 #language en-US "UTC-05:00, Bogota, Lima, Quito, Eastern Time(US & Canada)\r\n"\r | |
109 | #string STR_TIMEZONE_M430 #language en-US "UTC-04:30, Caracas\r\n"\r | |
110 | #string STR_TIMEZONE_M4 #language en-US "UTC-04:00, Atlantic Time(Canada), Caracas, Santiago\r\n"\r | |
111 | #string STR_TIMEZONE_M330 #language en-US "UTC-03:30, Newfoundland\r\n"\r | |
112 | #string STR_TIMEZONE_M3 #language en-US "UTC-03:00, Brasilia, Buenos Aires, Georgetown, Greenland\r\n"\r | |
113 | #string STR_TIMEZONE_M2 #language en-US "UTC-02:00, Mid-Atlantic\r\n"\r | |
114 | #string STR_TIMEZONE_M1 #language en-US "UTC-01:00, Azores, Cape Verde Is.\r\n"\r | |
115 | #string STR_TIMEZONE_0 #language en-US "UTC , Greenwich Mean Time, Casablanca, Monrovia, Dublin, London\r\n"\r | |
116 | #string STR_TIMEZONE_P1 #language en-US "UTC+01:00, Amsterdam, Berlin, Bern, Rome, Paris, West Central Africa\r\n"\r | |
117 | #string STR_TIMEZONE_P2 #language en-US "UTC+02:00, Athens, Istanbul, Bucharest, Cairo, Jerusalem\r\n"\r | |
118 | #string STR_TIMEZONE_P3 #language en-US "UTC+03:00, Baghdad, Kuwait, Riyadh, Moscow, Nairobi\r\n"\r | |
119 | #string STR_TIMEZONE_P330 #language en-US "UTC+03:30, Tehran\r\n"\r | |
120 | #string STR_TIMEZONE_P4 #language en-US "UTC+04:00, Abu Dhabi, Muscat, Baku, Tbilisi, Yerevan\r\n"\r | |
121 | #string STR_TIMEZONE_P430 #language en-US "UTC+04:30, Kabul\r\n"\r | |
122 | #string STR_TIMEZONE_P5 #language en-US "UTC+05:00, Ekaterinburg, Islamabad, Karachi, Tashkent\r\n"\r | |
123 | #string STR_TIMEZONE_P530 #language en-US "UTC+05:30, Chennai, Kolkata, Mumbai, New Delhi\r\n"\r | |
124 | #string STR_TIMEZONE_P545 #language en-US "UTC+05:45, Kathmandu\r\n"\r | |
125 | #string STR_TIMEZONE_P6 #language en-US "UTC+06:00, Almaty, Novosibirsk, Astana, Dhaka, Sri Jayawardenepura\r\n"\r | |
126 | #string STR_TIMEZONE_P630 #language en-US "UTC+06:30, Rangoon\r\n"\r | |
127 | #string STR_TIMEZONE_P7 #language en-US "UTC+07:00, Bangkok, Hanio, Jakarta, Krasnoyarsk\r\n"\r | |
128 | #string STR_TIMEZONE_P8 #language en-US "UTC+08:00, Beijing, Chongqing, Hong Kong, Urumqi, Taipei, Perth\r\n"\r | |
129 | #string STR_TIMEZONE_P9 #language en-US "UTC+09:00, Osaka, Sapporo, Tokyo, Seoul, Yakutsk\r\n"\r | |
130 | #string STR_TIMEZONE_P930 #language en-US "UTC+09:30, Adelaide, Darwin\r\n"\r | |
131 | #string STR_TIMEZONE_P10 #language en-US "UTC+10:00, Canberra, Melbourne, Sydney, Guam, Hobart, Vladivostok\r\n"\r | |
132 | #string STR_TIMEZONE_P11 #language en-US "UTC+11:00, Magadan, Solomon Is., New Caledonia\r\n"\r | |
133 | #string STR_TIMEZONE_P12 #language en-US "UTC+12:00, Auckland, Wellington, Fiji, Kamchatka, Marshall Is.\r\n"\r | |
134 | #string STR_TIMEZONE_P13 #language en-US "UTC+13:00, Nuku'alofa\r\n"\r | |
135 | #string STR_TIMEZONE_P14 #language en-US "UTC+14:00, Line Islands\r\n"\r | |
136 | #string STR_TIMEZONE_LOCAL #language en-US "LOCAL , Local Time\r\n"\r | |
137 | #string STR_TIMEZONE_SIMPLE #language en-US "UTC%1s%02d:%02d\r\n"\r | |
138 | #string STR_TIMEZONE_SIMPLE_LOCAL #language en-US "LOCAL\r\n"\r | |
139 | #string STR_TIMEZONE_NI #language en-US "No additional information known."\r | |
140 | \r | |
141 | #string STR_LOAD_NOT_IMAGE #language en-US "Image '%s' is not an image.\r\n"\r | |
142 | #string STR_LOAD_NOT_DRIVER #language en-US "Image '%s' is not a driver.\r\n"\r | |
143 | #string STR_LOAD_LOADED #language en-US "Image '%s' loaded at %x - %r\r\n"\r | |
144 | #string STR_LOAD_ERROR #language en-US "Image '%s' error in StartImage: %r\r\n"\r | |
145 | \r | |
146 | #string STR_LS_LINE_START_ALL #language en-US "%t %5s %1c % ,L11d "\r | |
147 | #string STR_LS_LINE_END_FILE #language en-US "%s\r\n"\r | |
148 | #string STR_LS_LINE_END_EXE #language en-US "%V%s%N\r\n"\r | |
149 | #string STR_LS_LINE_END_DIR #language en-US "%B%s%N\r\n"\r | |
150 | #string STR_LS_FOOTER_LINE #language en-US "% ,L11d File(s) % ,L11d bytes\r\n% ,L11d Dir(s)\r\n"\r | |
151 | #string STR_LS_HEADER_LINE1 #language en-US "Directory of: %H%s%N\r\n"\r | |
152 | #string STR_LS_FILE_NOT_FOUND #language en-US "%H%s%N: File Not Found - '%H%s%N'\r\n"\r | |
153 | #string STR_LS_SFO_VOLINFO #language en-US "VolumeInfo,"%s","%Ld","%5s","%Ld","%Ld"\r\n"\r | |
154 | #string STR_LS_SFO_FILEINFO #language en-US "FileInfo,"%s","%Ld","%Ld","%s%s%s%s%s","%02d:%02d:%02d","%02d.%02d.%04d","%02d:%02d:%02d","%02d.%02d.%04d","%02d:%02d:%02d","%02d.%02d.%04d"\r\n"\r | |
155 | \r | |
156 | #string STR_VOL_VOLINFO #language en-US "Volume %s (%s)\r\n"\r | |
157 | "%Ld bytes total disk space\r\n"\r | |
158 | "%Ld bytes available on disk\r\n"\r | |
159 | "%d bytes in each allocation unit\r\n"\r | |
160 | \r | |
161 | #string STR_RM_LOG_DELETE_CONF #language en-US "Remove Subtree '%B%s%N' [y/n]?"\r | |
162 | #string STR_RM_LOG_DELETE #language en-US "Deleting '%B%s%N'\r\n"\r | |
163 | #string STR_RM_LOG_DELETE_ERR #language en-US "Delete error: %r\r\n"\r | |
164 | #string STR_RM_LOG_DELETE_ERR2 #language en-US "Delete error. Couldn't open file: %r\r\n"\r | |
165 | #string STR_RM_LOG_DELETE_ERR3 #language en-US "Delete error. Invalid target '%B%s%N'\r\n"\r | |
166 | #string STR_RM_LOG_DELETE_COMP #language en-US "Delete successful.\r\n"\r | |
167 | #string STR_RM_LOG_DETELE_RO #language en-US "%H%s%N: '%H%s%N' is read-only\r\n"\r | |
168 | \r | |
169 | #string STR_MV_OUTPUT #language en-US "Moving %s -> %s\r\n"\r | |
170 | #string STR_MV_INV_SUB #language en-US "Cannot move a directory into itself or its subdirectory.\r\n"\r | |
171 | #string STR_MV_INV_RO #language en-US "Cannot move to or from a read-only file or directory '%B%s%N'\r\n"\r | |
172 | #string STR_MV_INV_CWD #language en-US "Cannot move current working directory or its subdirectory.\r\n"\r | |
173 | \r | |
174 | #string STR_CP_OUTPUT #language en-US "Copying %s -> %s\r\n"\r | |
175 | #string STR_CP_ERROR #language en-US "%H%s%N: Could not copy - '%H%s%N'\r\n"\r | |
176 | #string STR_CP_DIR_REQ #language en-US "%H%s%N: Copying a directory requires -r.\r\n"\r | |
177 | #string STR_CP_DIR_WNF #language en-US "%H%s%N: The specified path does not exist - '%H%s%N'\r\n"\r | |
178 | #string STR_CP_SD_SAME #language en-US "%H%s%N: The source and destination are the same.\r\n"\r | |
179 | #string STR_CP_SD_PARENT #language en-US "%H%s%N: The destination is a parent of the source.\r\n"\r | |
180 | #string STR_CP_DEST_ERROR #language en-US "%H%s%N: The destination is read-only.\r\n"\r | |
181 | #string STR_CP_DEST_OPEN_FAIL #language en-US "%H%s%N: The destination file '%B%s%N' failed to open with create.\r\n"\r | |
182 | #string STR_CP_DEST_DIR_FAIL #language en-US "%H%s%N: The destination directory '%B%s%N' could not be created.\r\n"\r | |
183 | #string STR_CP_SRC_OPEN_FAIL #language en-US "%H%s%N: The source file '%B%s%N' failed to open with read.\r\n"\r | |
184 | \r | |
185 | #string STR_GET_HELP_ATTRIB #language en-US ""\r | |
186 | ".TH attrib 0 "Displays or modifies the attributes of files or directories."\r\n"\r | |
187 | ".SH NAME\r\n"\r | |
188 | "Displays or modifies the attributes of files or directories.\r\n"\r | |
189 | ".SH SYNOPSIS\r\n"\r | |
190 | " \r\n"\r | |
191 | "ATTRIB [+a|-a] [+s|-s] [+h|-h] [+r|-r] [file...] [directory...]\r\n"\r | |
192 | ".SH OPTIONS\r\n"\r | |
193 | " \r\n"\r | |
194 | " +a|-a - Sets or clears the 'archive' attribute.\r\n"\r | |
195 | " +s|-s - Sets or clears the 'system' attribute.\r\n"\r | |
196 | " +h|-h - Sets or clears the 'hidden' attribute.\r\n"\r | |
197 | " +r|-r - Sets or clears the 'read-only' attribute.\r\n"\r | |
198 | " file - Specifies the file name (wild cards are permitted).\r\n"\r | |
199 | " directory - Specifies the directory name (wildcards are permitted).\r\n"\r | |
200 | ".SH DESCRIPTION\r\n"\r | |
201 | " \r\n"\r | |
202 | "NOTES:\r\n"\r | |
203 | " 1. Four attribute types are supported in the UEFI file system:\r\n"\r | |
204 | " - Archive [A]\r\n"\r | |
205 | " - System [S]\r\n"\r | |
206 | " - Hidden [H]\r\n"\r | |
207 | " - Read only [R]\r\n"\r | |
208 | " 2. If a file (in general meaning) is a directory, then it is also shown\r\n"\r | |
209 | " to have the attribute [D].\r\n"\r | |
210 | " 3. If any file in the file list that is specified \r\n"\r | |
211 | " does not exist, attrib will continue processing the remaining files\r\n"\r | |
212 | " while reporting the error.\r\n"\r | |
213 | " 4. If no attributes parameters are specified, the current attributes of\r\n"\r | |
214 | " the specified files or directories are displayed.\r\n"\r | |
215 | " 5. If no files or directories are specified, the command applies to\r\n"\r | |
216 | " all files and sub-directories within the current directory.\r\n"\r | |
217 | ".SH EXAMPLES\r\n"\r | |
218 | " \r\n"\r | |
219 | "EXAMPLES:\r\n"\r | |
220 | " * To display the attributes of a directory:\r\n"\r | |
221 | " fs0:\> attrib fs0:\ \r\n"\r | |
222 | " \r\n"\r | |
223 | " * To display the attributes of all files and sub-directories in the current\r\n"\r | |
224 | " directory:\r\n"\r | |
225 | " fs0:\> attrib *\r\n"\r | |
226 | " \r\n"\r | |
227 | " * To add the system attribute to all files with extension '.efi':\r\n"\r | |
228 | " fs0:\> attrib +s *.efi\r\n"\r | |
229 | " \r\n"\r | |
230 | " * To remove the read-only attribute from all files with extension '.inf':\r\n"\r | |
231 | " fs0:\> attrib -r *.inf\r\n"\r | |
232 | ".SH RETURNVALUES\r\n"\r | |
233 | " \r\n"\r | |
234 | "RETURN VALUES:\r\n"\r | |
235 | " SHELL_SUCCESS The action was completed as requested.\r\n"\r | |
236 | " SHELL_NOT_FOUND The requested file was not found.\r\n"\r | |
237 | " SHELL_INVALID_PARAMETER One of the passed-in parameters was incorrectly\r\n"\r | |
238 | " formatted or its value was out of bounds.\r\n"\r | |
239 | " SHELL_SECURITY_VIOLATION This function was not performed due to a security\r\n"\r | |
240 | " violation.\r\n"\r | |
241 | " SHELL_WRITE_PROTECTED The media that the action was to take place on is\r\n"\r | |
242 | " write-protected.\r\n"\r | |
243 | \r | |
244 | #string STR_GET_HELP_CD #language en-US ""\r | |
245 | ".TH cd 0 "Displays or changes the current directory."\r\n"\r | |
246 | ".SH NAME\r\n"\r | |
247 | "Displays or changes the current directory.\r\n"\r | |
248 | ".SH SYNOPSIS\r\n"\r | |
249 | " \r\n"\r | |
250 | "CD [path]\r\n"\r | |
251 | ".SH OPTIONS\r\n"\r | |
252 | " \r\n"\r | |
253 | " path - Specifies the relative or absolute directory path.\r\n"\r | |
254 | ".SH DESCRIPTION\r\n"\r | |
255 | " \r\n"\r | |
256 | "NOTES:\r\n"\r | |
257 | " 1. This command changes the current working directory that is used by the\r\n"\r | |
258 | " UEFI Shell environment. If a file system mapping is specified, then the\r\n"\r | |
259 | " current working directory is changed for that device. Otherwise, the\r\n"\r | |
260 | " current working directory is changed for the current device.\r\n"\r | |
261 | " 2. If path is not present, then the current working directory (including\r\n"\r | |
262 | " file system mapping) is displayed to standard out.\r\n"\r | |
263 | " 3. The table below describes the conventions that are used to refer to the\r\n"\r | |
264 | " directory, its parent, and the root directory in the UEFI Shell\r\n"\r | |
265 | " environment.\r\n"\r | |
266 | " Convention Description\r\n"\r | |
267 | " '.' Refers to the current directory.\r\n"\r | |
268 | " '..' Refers to the directory's parent.\r\n"\r | |
269 | " '\\\' Refers to the root of the current file system.\r\n"\r | |
270 | " 4. The current working directory is maintained in the environment\r\n"\r | |
271 | " variable %cwd%.\r\n"\r | |
272 | ".SH EXAMPLES\r\n"\r | |
273 | " \r\n"\r | |
274 | "EXAMPLES:\r\n" \r | |
275 | " * To change the current file system to the mapped fs0 file system:\r\n"\r | |
276 | " Shell> fs0:\r\n"\r | |
277 | " \r\n"\r | |
278 | " * To change the current directory to subdirectory 'efi':\r\n"\r | |
279 | " fs0:\> cd efi\r\n"\r | |
280 | " \r\n"\r | |
281 | " * To change the current directory to the parent directory (fs0:\):\r\n"\r | |
282 | " fs0:\efi\> cd ..\r\n"\r | |
283 | " \r\n"\r | |
284 | " * To change the current directory to 'fs0:\efi\Tools':\r\n"\r | |
285 | " fs0:\> cd efi\Tools\r\n"\r | |
286 | " \r\n"\r | |
287 | " * To change the current directory to the root of the current fs (fs0):\r\n"\r | |
288 | " fs0:\efi\Tools\> cd \ \r\n"\r | |
289 | " \r\n"\r | |
290 | " * To move between volumes and maintain the current path, and then copy\r\n"\r | |
291 | " all of files in fs0:\efi\Tools into the fs1:\Tmp directory:\r\n"\r | |
292 | " fs0:\> cd \efi\Tools\r\n"\r | |
293 | " fs0:\efi\Tools\> fs1:\r\n"\r | |
294 | " fs1:\> cd Tmp\r\n"\r | |
295 | ".SH RETURNVALUES\r\n"\r | |
296 | " \r\n"\r | |
297 | "RETURN VALUES:\r\n" \r | |
298 | " SHELL_SUCCESS The action was completed as requested.\r\n"\r | |
299 | " SHELL_SECURITY_VIOLATION This function was not performed due to a security\r\n"\r | |
300 | " violation.\r\n"\r | |
301 | " SHELL_INVALID_PARAMETER One of the passed-in parameters was incorrectly\r\n"\r | |
302 | " formatted or its value was out of bounds.\r\n"\r | |
303 | \r | |
304 | #string STR_GET_HELP_CP #language en-US ""\r | |
305 | ".TH cp 0 "Copies files or directories."\r\n"\r | |
306 | ".SH NAME\r\n"\r | |
307 | "Copies one or more files or directories to another location.\r\n"\r | |
308 | ".SH SYNOPSIS\r\n"\r | |
309 | " \r\n"\r | |
310 | "CP [-r] [-q] src [src...] [dst]\r\n"\r | |
311 | ".SH OPTIONS\r\n"\r | |
312 | " \r\n"\r | |
313 | " -r - Makes a recursive copy.\r\n"\r | |
314 | " -q - Makes a quiet copy (without a prompt).\r\n"\r | |
315 | " src - Specifies a source file/directory name (wildcards are permitted).\r\n"\r | |
316 | " dst - Specifies a destination file/directory name (wildcards are not permitted). \r\n"\r | |
317 | " If more than one directory is specified, the last directory is\r\n"\r | |
318 | " assumed to be the destination.\r\n"\r | |
319 | ".SH DESCRIPTION\r\n"\r | |
320 | " \r\n"\r | |
321 | "NOTES:\r\n"\r | |
322 | " 1. '-r' must be specified if src is a directory. If '-r' is specified,\r\n"\r | |
323 | " the source directory is recursively copied to the destination.\r\n"\r | |
324 | " 'src' itself is copied.\r\n"\r | |
325 | " 2. If a destination is not specified, the current working directory is\r\n"\r | |
326 | " assumed to be the destination.\r\n"\r | |
327 | " 3. 'CP -r src1 src2 dst' copies all files and subdirectories in 'src1' and\r\n"\r | |
328 | " 'src2' to the destination 'dst'. 'src1' and 'src2' themselves are also\r\n"\r | |
329 | " copied. The 'dst' parameter is interpreted as a directory.\r\n"\r | |
330 | " 4. Copying a directory or file to itself is not allowed.\r\n"\r | |
331 | " 5. If an error occurs, this command exits immediately and the remaining files or\r\n"\r | |
332 | " directories are not copied.\r\n"\r | |
333 | " 6. When 'cp' is executed with a script file, it always performs quiet\r\n"\r | |
334 | " copying, regardless of whether the '-q' option is specified.\r\n"\r | |
335 | " 7. If you are copying multiple files, the destination must be an existing\r\n"\r | |
336 | " directory.\r\n"\r | |
337 | ".SH EXAMPLES\r\n"\r | |
338 | " \r\n"\r | |
339 | "EXAMPLES:\r\n"\r | |
340 | " * To display the contents of the current directory:\r\n"\r | |
341 | " fs0:\> ls\r\n"\r | |
342 | " \r\n"\r | |
343 | " * To copy a file in the same directory and change the file name:\r\n"\r | |
344 | " fs0:\> cp temp.txt readme.txt\r\n"\r | |
345 | " \r\n"\r | |
346 | " * To copy multiple files to another directory:\r\n"\r | |
347 | " fs0:\> cp temp.txt isaBus.efi \Test\r\n"\r | |
348 | " \r\n"\r | |
349 | " * To copy multiple directories recursively to another directory:\r\n"\r | |
350 | " fs0:\> cp -r test1 test2 boot \Test\r\n"\r | |
351 | " \r\n"\r | |
352 | " * To see the results of the above operations:\r\n"\r | |
353 | " fs0:\> ls \Test\r\n"\r | |
354 | ".SH RETURNVALUES\r\n"\r | |
355 | " \r\n"\r | |
356 | "RETURN VALUES:\r\n"\r | |
357 | " SHELL_SUCCESS The action was completed as requested.\r\n"\r | |
358 | " SHELL_INVALID_PARAMETER One of the passed-in parameters was incorrectly \r\n"\r | |
359 | " formatted or its value was out of bounds.\r\n"\r | |
360 | " SHELL_OUT_OF_RESOURCES There was insufficient space to save the \r\n"\r | |
361 | " requested file at the destination.\r\n"\r | |
362 | " SHELL_SECURITY_VIOLATION This function was not performed due to a security \r\n"\r | |
363 | " violation.\r\n"\r | |
364 | " SHELL_WRITE_PROTECTED An attempt was made to create a file on media that\r\n"\r | |
365 | " was write-protected.\r\n"\r | |
366 | \r | |
367 | #string STR_GET_HELP_MAP #language en-US ""\r | |
368 | ".TH map 0 "Displays or defines file system mappings"\r\n"\r | |
369 | ".SH NAME\r\n"\r | |
370 | "Displays or defines file system mappings.\r\n"\r | |
371 | ".SH SYNOPSIS\r\n"\r | |
372 | " \r\n"\r | |
373 | "MAP [-d <sname>]\r\n"\r | |
374 | "MAP [[-r][-v][-c][-f][-u][-t <type[,type...]>][sname]]\r\n"\r | |
375 | "MAP [sname handle | mapping]\r\n"\r | |
376 | ".SH OPTIONS\r\n"\r | |
377 | " \r\n"\r | |
378 | " -d - Deletes a file system mapping.\r\n"\r | |
379 | " -r - Resets file system mappings to default values.\r\n"\r | |
380 | " -u - Adds file system mappings for newly-installed devices and\r\n"\r | |
381 | " removes mappings for uninstalled devices. This does not change\r\n"\r | |
382 | " the mappings of existing devices and preserves user-defined mappings.\r\n"\r | |
383 | " -v - Displays verbose information about all file system mappings.\r\n"\r | |
384 | " -c - Displays the consistent mappings.\r\n"\r | |
385 | " -f - Displays the normal mappings (not the consistent mappings).\r\n"\r | |
386 | " -t - Displays the device mappings, filtered according to the device type.\r\n"\r | |
387 | " Supported types are:\r\n"\r | |
388 | " fp - Floppy\r\n"\r | |
389 | " hd - Hard Disk\r\n"\r | |
390 | " cd - CD-ROM\r\n"\r | |
391 | " Types can be combined by putting a comma between two types. Spaces\r\n"\r | |
392 | " are not allowed between types.\r\n"\r | |
393 | " -sfo - Displays information in Standard-Format Output.\r\n"\r | |
394 | " sname - Specifies a mapping name.\r\n"\r | |
395 | " handle - Specifies the number of a handle. Use the same value that is\r\n"\r | |
396 | " displayed by the 'dh' command.\r\n"\r | |
397 | " mapping - Specifies a new mapping name to assign to a device.\r\n"\r | |
398 | " This value must end with a ':'.\r\n"\r | |
399 | ".SH DESCRIPTION\r\n"\r | |
400 | " \r\n"\r | |
401 | "NOTES:\r\n"\r | |
402 | " 1. This command creates a mapping between a user-defined name and a device.\r\n"\r | |
403 | " The most common use of this command is to create a mapped name for\r\n"\r | |
404 | " devices that support a file system protocol. After these mappings are\r\n"\r | |
405 | " created, the names can be used with all the file manipulation commands.\r\n"\r | |
406 | " 2. The UEFI Shell environment creates default mappings for all of the\r\n"\r | |
407 | " devices that support a recognized file system.\r\n"\r | |
408 | " 3. This command can be used to create additional mappings, or \r\n"\r | |
409 | " when used with the -d option, to delete an existing mapping. If it is\r\n"\r | |
410 | " used without any parameters, all of the current mappings are listed.\r\n"\r | |
411 | " If the -v option is used, the mappings are shown with additional\r\n"\r | |
412 | " information about each device.\r\n"\r | |
413 | " 4. The -r option is used to reset all the default mappings in a system,\r\n"\r | |
414 | " which is useful if the system configuration has changed since the\r\n"\r | |
415 | " last boot.\r\n"\r | |
416 | " 5. The -u option adds mappings for newly-installed devices and removes\r\n"\r | |
417 | " mappings for uninstalled devices without changing the mappings of\r\n"\r | |
418 | " existing devices. User-defined mappings are also preserved. A mapping\r\n"\r | |
419 | " history is saved, which preserves the original mapping name for\r\n"\r | |
420 | " a device with a specific device path. The current directory is also\r\n"\r | |
421 | " preserved if the current device is not changed.\r\n"\r | |
422 | " 6. Each device in the system has a consistent mapping. If the hardware\r\n"\r | |
423 | " configuration has not changed, the device's consistent mappings do not\r\n"\r | |
424 | " change. If two or more machines have the same hardware configurations,\r\n"\r | |
425 | " the device's consistent mapping remains the same. Use the -c option to\r\n"\r | |
426 | " list all the consistent mappings in the system.\r\n"\r | |
427 | " 7. The mapping value must consist of digits and characters. Other\r\n"\r | |
428 | " characters are illegal.\r\n"\r | |
429 | " 8. This command support wildcards. You can use the wildcards to delete\r\n"\r | |
430 | " or show the mapping. However, when you assign the mapping, wildcards\r\n"\r | |
431 | " are forbidden.\r\n"\r | |
432 | ".SH EXAMPLES\r\n"\r | |
433 | " \r\n"\r | |
434 | "EXAMPLES:\r\n"\r | |
435 | " * To display verbose mapping table information:\r\n"\r | |
436 | " Shell> map -v\r\n"\r | |
437 | " \r\n"\r | |
438 | " * To assign a different name to fs0:\r\n"\r | |
439 | " Shell> map floppy fs0:\r\n"\r | |
440 | " \r\n"\r | |
441 | " * To operate with the mapped name:\r\n"\r | |
442 | " Shell> floppy:\r\n"\r | |
443 | " \r\n"\r | |
444 | " * To delete a mapped name:\r\n"\r | |
445 | " Shell> map -d floppy:\r\n"\r | |
446 | " \r\n"\r | |
447 | " * To display all the mapped names starting with 'f': \r\n"\r | |
448 | " Shell> map f* \r\n"\r | |
449 | ".SH RETURNVALUES\r\n"\r | |
450 | " \r\n"\r | |
451 | "RETURN VALUES:\r\n"\r | |
452 | " SHELL_SUCCESS The action was completed as requested.\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_INVALID_PARAMETER One of the passed-in parameters was incorrectly\r\n"\r | |
456 | " formatted or its value was out of bounds.\r\n"\r | |
457 | \r | |
458 | #string STR_GET_HELP_MKDIR #language en-US ""\r | |
459 | ".TH mkdir 0 "Creates directories."\r\n"\r | |
460 | ".SH NAME\r\n"\r | |
461 | "Creates one or more new directories.\r\n"\r | |
462 | ".SH SYNOPSIS\r\n"\r | |
463 | " \r\n"\r | |
464 | "MKDIR dir [dir...]\r\n"\r | |
465 | ".SH OPTIONS\r\n"\r | |
466 | " \r\n"\r | |
88f9acd6 HL |
467 | " dir - Specifies the name of a directory or directories to create.\r\n"\r |
468 | " (Wildcards are not allowed)\r\n"\r | |
e329f98b JJ |
469 | ".SH DESCRIPTION\r\n"\r |
470 | " \r\n"\r | |
471 | "NOTES:\r\n"\r | |
88f9acd6 HL |
472 | " 1. Mkdir can create one or more new directories.\r\n"\r |
473 | " 2. If dir includes nested directories, then parent directories will be\r\n"\r | |
474 | " created before child directories.\r\n"\r | |
475 | " 3. If the directory already exists, mkdir will exit with an error.\r\n"\r | |
e329f98b JJ |
476 | ".SH EXAMPLES\r\n"\r |
477 | " \r\n"\r | |
478 | "EXAMPLES:\r\n"\r | |
479 | " * To create a new directory:\r\n"\r | |
480 | " fs0:\> mkdir rafter\r\n"\r | |
481 | " \r\n"\r | |
482 | " * To create multiple directories:\r\n"\r | |
483 | " fs0:\> mkdir temp1 temp2\r\n"\r | |
484 | ".SH RETURNVALUES\r\n"\r | |
485 | " \r\n"\r | |
486 | "RETURN VALUES:\r\n"\r | |
487 | " SHELL_SUCCESS The action was completed as requested.\r\n"\r | |
488 | " SHELL_INVALID_PARAMETER One of the passed-in parameters was incorrectly \r\n"\r | |
489 | " formatted or its value was out of bounds.\r\n"\r | |
490 | " SHELL_OUT_OF_RESOURCES There was insufficient space on the destination \r\n"\r | |
491 | " to create the requested directory.\r\n"\r | |
492 | " SHELL_SECURITY_VIOLATION This function was not performed due to a security \r\n"\r | |
493 | " violation.\r\n"\r | |
494 | " SHELL_WRITE_PROTECTED An attempt was made to create a directory when the\r\n"\r | |
495 | " target media was write-protected.\r\n"\r | |
496 | \r | |
497 | #string STR_GET_HELP_MV #language en-US ""\r | |
498 | ".TH mv 0 "Moves files."\r\n"\r | |
499 | ".SH NAME\r\n"\r | |
500 | "Moves one or more files to a destination within or between file systems.\r\n"\r | |
501 | ".SH SYNOPSIS\r\n"\r | |
502 | " \r\n"\r | |
503 | "MV src [src...] [dst]\r\n"\r | |
504 | ".SH OPTIONS\r\n"\r | |
505 | " \r\n"\r | |
506 | " src - Specifies a source file/directory name (wildcards are permitted).\r\n"\r | |
507 | " dst - Specifies a destination file/directory name (wildcards are permitted).\r\n"\r | |
508 | ".SH DESCRIPTION\r\n"\r | |
509 | " \r\n"\r | |
510 | "NOTES:\r\n"\r | |
511 | " 1. This command moves one or more files to a destination within or between\r\n"\r | |
512 | " file systems.\r\n"\r | |
513 | " 2. If the destination is an existing directory, the sources are moved\r\n"\r | |
514 | " into that directory. You cannot move the sources to a non-existing\r\n"\r | |
515 | " directory.\r\n"\r | |
516 | " 3. If a destination is not specified, the current directory is assumed to be\r\n"\r | |
517 | " the destination. If there is more than one argument on the command line,\r\n"\r | |
518 | " the last one is assumed to be the destination.\r\n"\r | |
519 | " 4. Attempting to move a read-only file/directory results in an error.\r\n"\r | |
520 | " Moving a directory that contains read-only files is allowed.\r\n"\r | |
521 | " 5. You cannot move a directory into itself or its subdirectories.\r\n"\r | |
522 | " 6. You cannot move a directory if the current working directory is itself or\r\n"\r | |
523 | " its subdirectories.\r\n"\r | |
524 | " 7. If an error occurs, the remaining files or directories are still be\r\n"\r | |
525 | " moved.\r\n"\r | |
526 | ".SH EXAMPLES\r\n"\r | |
527 | " \r\n"\r | |
528 | "EXAMPLES:\r\n"\r | |
529 | " * To rename a file:\r\n"\r | |
530 | " fs0:\> mv IsaBus.efi Bus.efi\r\n"\r | |
531 | " \r\n"\r | |
532 | " * To move a directory to the current directory:\r\n"\r | |
533 | " fs0:\> mkdir Test1\Temp\r\n"\r | |
534 | " fs0:\> mv Test1\Temp\r\n"\r | |
535 | " \r\n"\r | |
536 | " * To rename a directory:\r\n"\r | |
537 | " fs0:\> mv efi efi1.1\r\n"\r | |
538 | " \r\n"\r | |
539 | " * To move multiple directories at a time:\r\n"\r | |
540 | " fs0:\> mv Test1 Test2 Test\r\n"\r | |
541 | " \r\n"\r | |
542 | " * To attempt moving a read-only directory, which results in a failure:\r\n"\r | |
543 | " fs0:\Test> attrib +r Temp1\r\n"\r | |
544 | " DA R fs0:\Test\Temp1\r\n"\r | |
545 | " fs0:\Test> mv Temp1 Temp2\r\n"\r | |
546 | ".SH RETURNVALUES\r\n"\r | |
547 | " \r\n"\r | |
548 | "RETURN VALUES:\r\n"\r | |
549 | " SHELL_SUCCESS The action was completed as requested.\r\n"\r | |
550 | " SHELL_SECURITY_VIOLATION This function was not performed due to a security\r\n"\r | |
551 | " violation.\r\n"\r | |
552 | " SHELL_INVALID_PARAMETER One of the passed-in parameters was incorrectly\r\n"\r | |
553 | " formatted or its value was out of bounds.\r\n"\r | |
554 | " SHELL_NOT_FOUND The source file was not able to be found.\r\n"\r | |
555 | " SHELL_OUT_OF_RESOURCES There was insufficient free space to move the\r\n"\r | |
556 | " requested file to its destination.\r\n"\r | |
557 | " SHELL_WRITE_PROTECTED An attempt was made to create a file on media that\r\n"\r | |
558 | " was write-protected.\r\n"\r | |
559 | \r | |
560 | #string STR_GET_HELP_PARSE #language en-US ""\r | |
561 | ".TH parse 0 "Parses standard format output files."\r\n"\r | |
562 | ".SH NAME\r\n"\r | |
563 | "Retrieves a value from a standard format output file.\r\n"\r | |
564 | ".SH SYNOPSIS\r\n"\r | |
565 | " \r\n"\r | |
566 | "PARSE filename tablename column [-i <Instance>] [-s <Instance>]\r\n"\r | |
567 | ".SH OPTIONS\r\n"\r | |
568 | " \r\n"\r | |
569 | " filename - Specifies a source file name.\r\n"\r | |
570 | " tablename - Specifies the name of the table to be parsed.\r\n"\r | |
571 | " column - Specifies the one-based column index to use to determine which value\r\n"\r | |
572 | " from a particular record to parse.\r\n"\r | |
573 | " -i <Instance> - Specifies an instance number to use to start parsing the ShellCommand table,\r\n"\r | |
574 | " and then the specified tablename. If not specified, all instances are returned.\r\n"\r | |
575 | " -s <Instance> - Specifies an instance number to use to start parsing the ShellCommand\r\n"\r | |
576 | " table. If not present, then 1 is assumed.\r\n"\r | |
577 | ".SH DESCRIPTION\r\n"\r | |
578 | " \r\n"\r | |
579 | "NOTES:\r\n"\r | |
580 | " 1. This command enables you to parse data from a file that has been output\r\n"\r | |
581 | " using the -sfo parameter.\r\n"\r | |
582 | " 2. Since the standard formatted output has a well known means of parsing,\r\n"\r | |
583 | " this command is intended to provide an easy way of enabling\r\n"\r | |
584 | " scripts to consume retrieved data from such constructed output files, and\r\n"\r | |
585 | " use it in the logic of scripts written for the UEFI shell.\r\n"\r | |
586 | ".SH EXAMPLES\r\n"\r | |
587 | " \r\n"\r | |
588 | "EXAMPLES:\r\n"\r | |
589 | " * The following data is contained in a temporary file (temp.txt):\r\n"\r | |
590 | " ShellCommand,"ls"\r\n"\r | |
591 | " VolumeInfo,"MikesVolume","400000000","FALSE","32000000","16000000"\r\n"\r | |
592 | " FileInfo,"FS0:\efi\\boot\winloader.efi","45670","45900","arsh","08:30:12","01.08.2013","00:00:00","01.08.2013","08:30:12","01.08.2013"\r\n"\r | |
593 | " FileInfo,"FS0:\efi\\boot\mikesfile.txt","1250","1280","a","08:30:12","01.08.2013","00:00:00","01.08.2013","08:30:12","01.08.2013"\r\n"\r | |
594 | " FileInfo,"FS0:\efi\\boot\\readme.txt","795","900","a","08:30:12","01.08.2013","00:00:00","01.08.2013","08:30:12","01.08.2013"\r\n"\r | |
595 | " \r\n"\r | |
596 | " * To display VolumeInfo column 2 in temp.txt:\r\n"\r | |
597 | " fs0:\> parse temp.txt VolumeInfo 2\r\n"\r | |
598 | " MikesVolume\r\n"\r | |
599 | " \r\n"\r | |
600 | " * To display FileInfo column 3 in temp.txt, starting with instance 3:\r\n"\r | |
601 | " fs0:\> parse temp.txt FileInfo 3 -i 3\r\n"\r | |
602 | " 795\r\n"\r | |
603 | ".SH RETURNVALUES\r\n"\r | |
604 | " \r\n"\r | |
605 | "RETURN VALUES:\r\n"\r | |
606 | " SHELL_SUCCESS The action was completed as requested.\r\n"\r | |
607 | " SHELL_SECURITY_VIOLATION This function was not performed due to a security\r\n"\r | |
608 | " violation.\r\n"\r | |
609 | " SHELL_INVALID_PARAMETER One of the passed-in parameters was incorrectly\r\n"\r | |
610 | " formatted or its value was out of bounds.\r\n"\r | |
611 | " SHELL_NOT_FOUND The source file was not able to be found.\r\n"\r | |
612 | \r | |
613 | #string STR_GET_HELP_RESET #language en-US ""\r | |
614 | ".TH reset 0 "Reset the system."\r\n"\r | |
615 | ".SH NAME\r\n"\r | |
616 | "Resets the system.\r\n"\r | |
617 | ".SH SYNOPSIS\r\n"\r | |
618 | " \r\n"\r | |
619 | "RESET [-w [string]]\r\n"\r | |
620 | "RESET [-s [string]]\r\n"\r | |
621 | "RESET [-c [string]]\r\n"\r | |
622 | ".SH OPTIONS\r\n"\r | |
623 | " \r\n"\r | |
624 | " -s - Performs a shutdown.\r\n"\r | |
625 | " -w - Performs a warm boot.\r\n"\r | |
626 | " -c - Performs a cold boot.\r\n"\r | |
627 | " string - Describes a reason for the reset.\r\n"\r | |
628 | ".SH DESCRIPTION\r\n"\r | |
629 | " \r\n"\r | |
630 | "NOTES:\r\n"\r | |
631 | " 1. This command resets the system.\r\n"\r | |
632 | " 2. The default is to perform a cold reset unless the -w parameter is\r\n"\r | |
633 | " specified.\r\n"\r | |
634 | " 3. If a reset string is specified, it is passed into the Reset() \r\n"\r | |
635 | " function, and the system records the reason for the system reset.\r\n"\r | |
636 | ".SH RETURNVALUES\r\n"\r | |
637 | " \r\n"\r | |
638 | "RETURN VALUES:\r\n"\r | |
639 | " SHELL_INVALID_PARAMETER One of the passed in parameters was incorrectly \r\n"\r | |
640 | " formatted or its value was out of bounds.\r\n"\r | |
641 | \r | |
642 | #string STR_GET_HELP_RM #language en-US ""\r | |
643 | ".TH rm 0 "Deletes one or more files or directories."\r\n"\r | |
644 | ".SH NAME\r\n"\r | |
645 | "Deletes one or more files or directories.\r\n"\r | |
646 | ".SH SYNOPSIS\r\n"\r | |
647 | " \r\n"\r | |
648 | "RM [-q] file/directory [file/directory ...]\r\n"\r | |
649 | ".SH OPTIONS\r\n"\r | |
650 | " \r\n"\r | |
651 | " -q - Specifies quiet mode. Does not prompt for a confirmation.\r\n"\r | |
652 | " file - Specifies a file name (wildcards are permitted).\r\n"\r | |
653 | " directory - Specifies a directory name (wildcards are permitted).\r\n"\r | |
654 | ".SH DESCRIPTION\r\n"\r | |
655 | " \r\n"\r | |
656 | "NOTES:\r\n"\r | |
657 | " 1. This command deletes one or more files or directories.\r\n"\r | |
658 | " 2. If the target is a directory, it deletes the directory, including all\r\n"\r | |
659 | " its subdirectories.\r\n"\r | |
660 | " 3. Redirecting a file whose parent directory (or the file\r\n"\r | |
661 | " itself) is being deleted is not allowed.\r\n"\r | |
662 | " 4. Removing a read-only file/directory results in a failure.\r\n"\r | |
663 | " 5. Removing a directory containing read-only file(s) results in\r\n"\r | |
664 | " a failure. If an error occurs, the command exits immediately and stops\r\n"\r | |
665 | " removing files/directories.\r\n"\r | |
666 | " 6. You cannot remove a directory when the current directory is itself or its\r\n"\r | |
667 | " subdirectory. If a file contains wildcards, you are not prompted for\r\n"\r | |
668 | " confirmation.\r\n"\r | |
669 | " 7. The root directory cannot be removed.\r\n"\r | |
670 | " 8. The current directory or its ancestor directories cannot be removed.\r\n"\r | |
671 | ".SH EXAMPLES\r\n"\r | |
672 | " \r\n"\r | |
673 | "EXAMPLES:\r\n"\r | |
674 | " * To remove multiple directories at a time:\r\n"\r | |
675 | " fs0:\> rm Test\Temp1 Temp2\r\n"\r | |
676 | " \r\n"\r | |
677 | " * To remove multiple directories with wildcards:\r\n"\r | |
678 | " fs0:\> rm Test\Temp*\r\n"\r | |
679 | " \r\n"\r | |
680 | " * To attempt removing a directory that contains a read-only file,\r\n"\r | |
681 | " which results in a failure:\r\n"\r | |
682 | " fs0:\> attrib +r Test\Temp1\readme.txt\r\n"\r | |
683 | " A R fs0:\Test\Temp1\readme.txt\r\n"\r | |
684 | " fs0:\> rm Test\Temp1\r\n"\r | |
685 | ".SH RETURNVALUES\r\n"\r | |
686 | " \r\n"\r | |
687 | "RETURN VALUES:\r\n"\r | |
688 | " SHELL_SUCCESS The action was completed as requested.\r\n"\r | |
689 | " SHELL_SECURITY_VIOLATION This function was not performed due to a security\r\n"\r | |
690 | " violation.\r\n"\r | |
691 | " SHELL_NOT_FOUND The source file was not able to be found.\r\n"\r | |
692 | " SHELL_WRITE_PROTECTED The target was write protected.\r\n"\r | |
693 | \r | |
694 | #string STR_GET_HELP_SET #language en-US ""\r | |
695 | ".TH set 0 "Displays or modifies UEFI Shell environment variables."\r\n"\r | |
696 | ".SH NAME\r\n"\r | |
697 | "Displays or modifies UEFI Shell environment variables.\r\n"\r | |
698 | ".SH SYNOPSIS\r\n"\r | |
699 | " \r\n"\r | |
700 | "SET [-v] [sname [value]]\r\n"\r | |
701 | "SET [-d <sname>]\r\n"\r | |
702 | ".SH OPTIONS\r\n"\r | |
703 | " \r\n"\r | |
704 | " -d - Deletes the environment variable.\r\n"\r | |
705 | " -v - Displays or modifies a volatile variable.\r\n"\r | |
706 | " sname - Specifies an environment variable name.\r\n"\r | |
707 | " value - Specifies an environment variable value.\r\n"\r | |
708 | ".SH DESCRIPTION\r\n"\r | |
709 | " \r\n"\r | |
710 | "NOTES:\r\n"\r | |
711 | " 1. This command is used to maintain the UEFI Shell environment variables.\r\n"\r | |
712 | " This command can do the following:\r\n"\r | |
713 | " - Display environment variables.\r\n"\r | |
714 | " - Create new environment variables.\r\n"\r | |
715 | " - Change the value of existing environment variables.\r\n"\r | |
716 | " - Delete environment variables.\r\n"\r | |
717 | " 2. This command sets an environment variable to a specified \r\n"\r | |
718 | " value. You can use it to create a new environment\r\n"\r | |
719 | " variable or to modify an existing environment variable.\r\n"\r | |
720 | " 3. If used without any parameters, all the environment variables\r\n"\r | |
721 | " are displayed.\r\n"\r | |
722 | " 4. If used with the -d option, the environment variable that\r\n"\r | |
723 | " is specified by sname is deleted.\r\n"\r | |
724 | ".SH EXAMPLES\r\n"\r | |
725 | " \r\n"\r | |
726 | "EXAMPLES:\r\n" \r | |
727 | " * To add an environment variable:\r\n"\r | |
728 | " Shell> set DiagnosticPath fs0:\efi\diag;fs1:\efi\diag\r\n"\r | |
729 | " \r\n"\r | |
730 | " * To display environment variables:\r\n"\r | |
731 | " Shell> set\r\n"\r | |
732 | " \r\n"\r | |
733 | " * To delete an environment variable:\r\n"\r | |
734 | " Shell> set -d diagnosticpath\r\n"\r | |
735 | " \r\n"\r | |
736 | " * To change an environment variable:\r\n"\r | |
737 | " fs0:\> set src efi\r\n"\r | |
738 | " fs0:\> set src efi1.1\r\n"\r | |
739 | " \r\n"\r | |
740 | " * To append an environment variable:\r\n"\r | |
741 | " Shell> set path %path%;fs0:\efi\Tools;fs0:\efi\boot;fs0:\\r\n"\r | |
742 | " \r\n"\r | |
743 | " * To set a volatile variable that will disappear at the next boot:\r\n"\r | |
744 | " Shell> set -v EFI_SOURCE c:\project\EFI1.1\r\n"\r | |
745 | ".SH RETURNVALUES\r\n"\r | |
746 | " \r\n"\r | |
747 | "RETURN VALUES:\r\n"\r | |
748 | " SHELL_SUCCESS The action was completed as requested.\r\n"\r | |
749 | " SHELL_SECURITY_VIOLATION This function was not performed due to a security\r\n"\r | |
750 | " violation.\r\n"\r | |
751 | " SHELL_OUT_OF_RESOURCES A request to set a variable in a non-volatile \r\n"\r | |
752 | " fashion could not be completed. The resulting \r\n"\r | |
753 | " non-volatile request has been converted into a \r\n"\r | |
754 | " volatile request.\r\n"\r | |
755 | \r | |
756 | #string STR_GET_HELP_DATE #language en-US ""\r | |
757 | ".TH date 0 "Displays and sets the current date for the system."\r\n"\r | |
758 | ".SH NAME\r\n"\r | |
759 | "Displays and sets the current date for the system.\r\n"\r | |
760 | ".SH SYNOPSIS\r\n"\r | |
761 | " \r\n"\r | |
762 | "DATE [mm/dd/[yy]yy][-sfo]\r\n"\r | |
763 | ".SH OPTIONS\r\n"\r | |
764 | " \r\n"\r | |
765 | " -sfo - Displays information in Standard-Format Output.\r\n"\r | |
766 | " mm - Specifies the month of the date to be set. (1-12)\r\n"\r | |
767 | " dd - Specifies the day of the date to be set (1-31)\r\n"\r | |
768 | " yy/yyyy - Specifies the year of the date to be set. If only two digits,\r\n"\r | |
769 | " then enter 9x = 199x. Otherwise enter 20xx.\r\n"\r | |
770 | ".SH DESCRIPTION\r\n"\r | |
771 | " \r\n"\r | |
772 | "NOTES:\r\n"\r | |
773 | " 1. This command displays and/or sets the current date for the system.\r\n"\r | |
774 | " If no parameters are used, it shows the current date. If a valid month,\r\n"\r | |
775 | " day, and year are specified, the system's date is updated.\r\n"\r | |
776 | " The following rules apply:\r\n"\r | |
777 | " - Except for numeric characters and /, all other characters in the\r\n"\r | |
778 | " argument are invalid.\r\n"\r | |
779 | " - The Shell reports an error if the number is in the wrong\r\n"\r | |
780 | " month/date/year range.\r\n"\r | |
781 | " - A space before or after the numeric character is not allowed. Inserting\r\n"\r | |
782 | " a space into the number is invalid.\r\n"\r | |
783 | " - Repeated zeros are allowed before the number. For example:\r\n"\r | |
784 | " Shell > date 0000008/000004/000097\r\n"\r | |
785 | " Shell > date\r\n"\r | |
786 | " 08/04/2097\r\n"\r | |
787 | " Shell >\r\n"\r | |
788 | " - The year range must be greater than or equal to 1998.\r\n"\r | |
789 | " - Two numeric characters indicate the year. Numbers below 98 are\r\n"\r | |
790 | " regarded as 20xx, and numbers equal to or above 98 are regarded as\r\n"\r | |
791 | " 19xx. 00 means 2000. For example:\r\n"\r | |
792 | " Shell > date 8/4/97\r\n"\r | |
793 | " Shell > date\r\n"\r | |
794 | " 08/04/2097\r\n"\r | |
795 | " Shell >\r\n"\r | |
796 | " Shell > date 8/4/98\r\n"\r | |
797 | " Shell > date\r\n"\r | |
798 | " 08/04/1998\r\n"\r | |
799 | " Shell >\r\n"\r | |
800 | " 2. The range of valid years is from 1998-2099.\r\n"\r | |
801 | ".SH EXAMPLES\r\n"\r | |
802 | " \r\n"\r | |
803 | "EXAMPLES:\r\n"\r | |
804 | " * To display the current date in the system:\r\n"\r | |
805 | " fs0:\> date\r\n"\r | |
806 | " \r\n"\r | |
807 | " * To set the date with long year format:\r\n"\r | |
808 | " fs0:\> date 01/01/2050\r\n"\r | |
809 | " \r\n"\r | |
810 | " * To set the date with short year format:\r\n"\r | |
811 | " fs0:\> date 06/18/01\r\n"\r | |
812 | ".SH RETURNVALUES\r\n"\r | |
813 | " \r\n"\r | |
814 | "RETURN VALUES:\r\n"\r | |
815 | " SHELL_SUCCESS The action was completed as requested.\r\n"\r | |
816 | " SHELL_DEVICE_ERROR There was a hardware error preventing the\r\n"\r | |
817 | " completion of this command.\r\n"\r | |
818 | " SHELL_SECURITY_VIOLATION This function was not performed due to a security\r\n"\r | |
819 | " violation.\r\n"\r | |
820 | " SHELL_INVALID_PARAMETER One of the passed-in parameters was incorrectly\r\n"\r | |
821 | " formatted or its value was out of bounds.\r\n"\r | |
822 | \r | |
823 | #string STR_GET_HELP_TIME #language en-US ""\r | |
824 | ".TH time 0 "Displays or sets the time for the system."\r\n"\r | |
825 | ".SH NAME\r\n"\r | |
826 | "Displays or sets the current time for the system.\r\n"\r | |
827 | ".SH SYNOPSIS\r\n"\r | |
828 | " \r\n"\r | |
829 | "TIME [hh:mm[:ss]] [-tz tz] [-d dl]\r\n"\r | |
830 | ".SH OPTIONS\r\n"\r | |
831 | " \r\n"\r | |
832 | " -d - Sets or displays a daylight savings time value.\r\n"\r | |
833 | " -tz - Specifies a time zone adjustment, measured in minutes offset from UTC. Valid values\r\n"\r | |
834 | " are between -1440 and 1440 or 2047. If not present or set to 2047,\r\n"\r | |
835 | " time is interpreted as local time.\r\n"\r | |
836 | " hh - Specifies a new hour (0-23) (required).\r\n"\r | |
837 | " mm - Specifies a new minute (0-59) (required).\r\n"\r | |
838 | " ss - Specifies a new second (0-59). If not specified, zero is used.\r\n"\r | |
839 | " dl - Specifies a daylight saving time value to set.\r\n"\r | |
840 | " 0 : Time is not affected.\r\n"\r | |
841 | " 1 : Time is affected, and has not been adjusted for daylight\r\n"\r | |
842 | " savings.\r\n"\r | |
843 | " 3 : Time is affected, and has been adjusted for daylight savings.\r\n"\r | |
844 | " All other values are invalid. If no value follows -d, the\r\n"\r | |
845 | " current daylight savings time is displayed.\r\n"\r | |
846 | ".SH DESCRIPTION\r\n"\r | |
847 | " \r\n"\r | |
848 | "NOTES:\r\n"\r | |
849 | " 1. This command displays or sets the current time for the system.\r\n"\r | |
850 | " If no parameters are used, it shows the current time. If valid hours, \r\n"\r | |
851 | " minutes, and seconds are provided, the system time is\r\n"\r | |
852 | " updated. Note the following rules:\r\n"\r | |
853 | " - Except for numeric characters and the : character, all other\r\n"\r | |
854 | " characters in the argument are invalid.\r\n"\r | |
855 | " - The Shell reports an error if the number is in the wrong \r\n"\r | |
856 | " hour/minute/second range.\r\n"\r | |
857 | " - Spaces before or after the numeric character and spaces inserted into\r\n"\r | |
858 | " the number are not allowed.\r\n"\r | |
859 | " - Repeated zeros are allowed before the number. For example:\r\n"\r | |
860 | " Shell> time 00000017:000004:0000\r\n"\r | |
861 | " Shell> time\r\n"\r | |
862 | " 17:04:00 (UTC+08:00)\r\n"\r | |
863 | " 2. The seconds parameter is optional. If none is specified, it is\r\n"\r | |
864 | " set to zero.\r\n"\r | |
865 | ".SH EXAMPLES\r\n"\r | |
866 | " \r\n"\r | |
867 | "EXAMPLES:\r\n"\r | |
868 | " * To display current system time:\r\n"\r | |
869 | " fs0:\> time\r\n"\r | |
870 | " \r\n"\r | |
871 | " * To set the system time:\r\n"\r | |
872 | " fs0:\> time 9:51:30\r\n"\r | |
873 | " \r\n"\r | |
874 | " * To display the system time, including daylight savings time:\r\n"\r | |
875 | " fs0:\> time -d\r\n"\r | |
876 | ".SH RETURNVALUES\r\n"\r | |
877 | " \r\n"\r | |
878 | "RETURN VALUES:\r\n"\r | |
879 | " SHELL_SUCCESS The action was completed as requested.\r\n"\r | |
880 | " SHELL_DEVICE_ERROR There was a hardware error preventing the\r\n"\r | |
881 | " completion of this command\r\n"\r | |
882 | " SHELL_SECURITY_VIOLATION This function was not performed due to a security\r\n"\r | |
883 | " violation.\r\n"\r | |
884 | " SHELL_INVALID_PARAMETER One of the passed-in parameters was incorrectly\r\n"\r | |
885 | " formatted or its value was out of bounds.\r\n"\r | |
886 | \r | |
887 | #string STR_GET_HELP_TIMEZONE #language en-US ""\r | |
888 | ".TH timezone 0 "Displays or sets time zone information."\r\n"\r | |
889 | ".SH NAME\r\n"\r | |
890 | "Displays or sets time zone information.\r\n"\r | |
891 | ".SH SYNOPSIS\r\n"\r | |
892 | " \r\n"\r | |
893 | "TIMEZONE [-s hh:mm | -l] [-b] [-f]\r\n"\r | |
894 | ".SH OPTIONS\r\n"\r | |
895 | " \r\n"\r | |
896 | " -s - Sets the time zone associated with hh:mm offset from UTC.\r\n"\r | |
897 | " -l - Displays a list of all time zones.\r\n"\r | |
898 | " -b - Displays one screen at a time.\r\n"\r | |
899 | " -f - Displays full information for the specified time zone.\r\n"\r | |
900 | ".SH DESCRIPTION\r\n"\r | |
901 | " \r\n"\r | |
902 | "NOTES:\r\n"\r | |
903 | " 1. This command displays and sets the current time zone for the system.\r\n"\r | |
904 | " 2. If no parameters are used, it shows the current time zone.\r\n"\r | |
905 | " 3. If a valid hh:mm parameter is provided, the time zone\r\n"\r | |
906 | " information is updated.\r\n"\r | |
907 | ".SH EXAMPLES\r\n"\r | |
908 | " \r\n"\r | |
909 | "EXAMPLES:\r\n"\r | |
910 | " * To display all available time zones:\r\n"\r | |
911 | " Shell> timezone -l\r\n"\r | |
912 | " \r\n"\r | |
913 | " * To set the time zone:\r\n"\r | |
914 | " Shell> timezone -s -7:00\r\n"\r | |
915 | " \r\n"\r | |
916 | " * To display detailed information for the current time zone:\r\n"\r | |
917 | " Shell> timezone -f\r\n"\r | |
918 | \r | |
919 | #string STR_GET_HELP_LS #language en-US ""\r | |
920 | ".TH ls 0 "Lists the contents of a directory or file information."\r\n"\r | |
921 | ".SH NAME\r\n"\r | |
922 | "Lists the contents of a directory or file information.\r\n"\r | |
923 | ".SH SYNOPSIS\r\n"\r | |
924 | " \r\n"\r | |
925 | "LS [-r] [-a[attrib]][-sfo][file]\r\n"\r | |
926 | ".SH OPTIONS\r\n"\r | |
927 | " \r\n"\r | |
928 | " -r - Displays recursively (including subdirectories).\r\n"\r | |
929 | " -a - Displays files with a specified attribute. If \r\n"\r | |
930 | " attribute is not specified, all files are listed. If -a is not\r\n"\r | |
931 | " specified, all non-system and non-hidden files are listed.\r\n"\r | |
932 | " -sfo - Displays information in Standard-Format Output.\r\n"\r | |
933 | " attrib - Specifies a file attribute list value:\r\n"\r | |
934 | " a - Archive\r\n"\r | |
935 | " s - System\r\n"\r | |
936 | " h - Hidden\r\n"\r | |
937 | " r - Read-only\r\n"\r | |
938 | " d - Directory\r\n"\r | |
939 | " file - Specifies a name of a file or directory (wildcards are permitted).\r\n"\r | |
940 | ".SH DESCRIPTION\r\n"\r | |
941 | " \r\n"\r | |
942 | "NOTES:\r\n"\r | |
943 | " 1. This command lists directory contents or file information. If no file\r\n"\r | |
944 | " name or directory name is specified, the current working directory\r\n"\r | |
945 | " is assumed.\r\n"\r | |
946 | " 2. The contents of a directory are listed if all of the following are true:\r\n"\r | |
947 | " - If option -r is not specified.\r\n"\r | |
948 | " - If no wildcard characters are specified in the file parameter.\r\n"\r | |
949 | " - If the file specified represents an existing directory.\r\n"\r | |
950 | " 3. In all other cases, the command functions as follows:\r\n"\r | |
951 | " - All files/directories that match the specified name are displayed.\r\n"\r | |
952 | " - The -r flag determines whether a recursive search is performed.\r\n"\r | |
953 | " - The option flag -a[attrib] only displays those\r\n"\r | |
954 | " files with the attributes that are specified.\r\n"\r | |
955 | " - If more than one attribute is specified, only the files that have all\r\n"\r | |
956 | " those attributes are listed.\r\n"\r | |
957 | " - If -a is followed by nothing, then all files/directories are\r\n"\r | |
958 | " displayed, regardless of their attributes.\r\n"\r | |
959 | " - If -a itself is not specified, then all files except system and\r\n"\r | |
960 | " hidden files are displayed.\r\n"\r | |
961 | ".SH EXAMPLES\r\n"\r | |
962 | " \r\n"\r | |
963 | "EXAMPLES:\r\n"\r | |
964 | " * To hide files by adding the hidden or system attribute to them:\r\n"\r | |
965 | " fs0:\> attrib +s +h *.efi\r\n"\r | |
966 | " \r\n"\r | |
967 | " * To display all, except the files/directories with 'h' or 's' attribute:\r\n"\r | |
968 | " fs0:\> ls\r\n"\r | |
969 | " \r\n"\r | |
970 | " * To display files with all attributes in the current directory:\r\n"\r | |
971 | " fs0:\> ls -a\r\n"\r | |
972 | " \r\n"\r | |
973 | " * To display files with read-only attributes in the current directory:\r\n"\r | |
974 | " fs0:\> ls -ar\r\n"\r | |
975 | " \r\n"\r | |
976 | " * To display the files with attribute of 's':\r\n"\r | |
977 | " fs0:\> ls -as isabus.efi\r\n"\r | |
978 | " \r\n"\r | |
979 | " * To display all in fs0:\efi directory recursively:\r\n"\r | |
980 | " fs0:\> ls -r -a efi\r\n"\r | |
981 | " \r\n"\r | |
982 | " * To display files with a specified type in the current directory: \r\n"\r | |
983 | " recursively:\r\n"\r | |
984 | " fs0:\> ls -r -a *.efi -b\r\n"\r | |
985 | ".SH RETURNVALUES\r\n"\r | |
986 | " \r\n"\r | |
987 | "RETURN VALUES:\r\n"\r | |
988 | " SHELL_SUCCESS The action was completed as requested.\r\n"\r | |
989 | " SHELL_INVALID_PARAMETER One of the passed-in parameters was incorrectly\r\n"\r | |
990 | " formatted or its value was out of bounds.\r\n"\r | |
991 | " SHELL_SECURITY_VIOLATION This function was not performed due to a security\r\n"\r | |
992 | " violation.\r\n"\r | |
993 | " SHELL_NOT_FOUND The requested file or directory was not found.\r\n"\r | |
994 | \r | |
995 | #string STR_GET_HELP_LOAD #language en-US ""\r | |
996 | ".TH load 0 "Loads a UEFI driver into memory."\r\n"\r | |
997 | ".SH NAME\r\n"\r | |
998 | "Loads a UEFI driver into memory.\r\n"\r | |
999 | ".SH SYNOPSIS\r\n"\r | |
1000 | " \r\n"\r | |
1001 | "LOAD [-nc] file [file...]\r\n"\r | |
1002 | ".SH OPTIONS\r\n"\r | |
1003 | " \r\n"\r | |
1004 | " -nc - Loads the driver, but does not connect the driver.\r\n"\r | |
1005 | " File - Specifies a file that contains the image of the UEFI driver (wildcards are\r\n"\r | |
1006 | " permitted).\r\n"\r | |
1007 | ".SH DESCRIPTION\r\n"\r | |
1008 | " \r\n"\r | |
1009 | "NOTES:\r\n"\r | |
1010 | " 1. This command loads a driver into memory. It can load multiple files at\r\n"\r | |
1011 | " one time. The file name supports wildcards.\r\n"\r | |
1012 | " 2. If the -nc flag is not specified, this command attempts to connect the\r\n"\r | |
1013 | " driver to a proper device. It might also cause previously loaded drivers\r\n"\r | |
1014 | " to be connected to their corresponding devices.\r\n"\r | |
1015 | " 3. Use the 'UNLOAD' command to unload a driver.\r\n"\r | |
1016 | ".SH EXAMPLES\r\n"\r | |
1017 | " \r\n"\r | |
1018 | "EXAMPLES:\r\n"\r | |
1019 | " * To load a driver:\r\n"\r | |
1020 | " fs0:\> load Isabus.efi\r\n"\r | |
1021 | " \r\n"\r | |
1022 | " * To load multiple drivers:\r\n"\r | |
1023 | " fs0:\> load Isabus.efi IsaSerial.efi\r\n"\r | |
1024 | " \r\n"\r | |
1025 | " * To load multiple drivers using file name wildcards:\r\n"\r | |
1026 | " fs0:\> load Isa*.efi\r\n"\r | |
1027 | " \r\n"\r | |
1028 | " * To load a driver without connecting it to a device:\r\n"\r | |
1029 | " fs0:\> load -nc IsaBus.efi\r\n"\r | |
1030 | ".SH RETURNVALUES\r\n"\r | |
1031 | " \r\n"\r | |
1032 | "RETURN VALUES:\r\n"\r | |
1033 | " SHELL_SUCCESS The action was completed as requested.\r\n"\r | |
1034 | " SHELL_INVALID_PARAMETER One of the passed-in parameters was incorrectly\r\n"\r | |
1035 | " formatted or its value was out of bounds.\r\n"\r | |
1036 | " SHELL_SECURITY_VIOLATION This function was not performed due to a security\r\n"\r | |
1037 | " violation.\r\n"\r | |
1038 | " SHELL_NOT_FOUND The requested file was not found.\r\n"\r | |
1039 | \r | |
1040 | #string STR_GET_HELP_VOL #language en-US ""\r | |
1041 | ".TH vol 0 "Displays or modifies information about a disk volume."\r\n"\r | |
1042 | ".SH NAME\r\n"\r | |
1043 | "Displays or modifies information about a disk volume.\r\n"\r | |
1044 | ".SH SYNOPSIS\r\n"\r | |
1045 | " \r\n"\r | |
1046 | "VOL [fs] [-n <VolumeLabel>]\r\n"\r | |
1047 | "VOL [fs] [-d]\r\n"\r | |
1048 | ".SH OPTIONS\r\n"\r | |
1049 | " \r\n"\r | |
1050 | " -n - Displays or modifies a new volume label.\r\n"\r | |
1051 | " -d - Displays or modifies an empty volume label.\r\n"\r | |
1052 | " fs - Specifies the name of the file system.\r\n"\r | |
1053 | " VolumeLabel - Specifies a volume label.\r\n"\r | |
1054 | ".SH DESCRIPTION\r\n"\r | |
1055 | " \r\n"\r | |
1056 | "NOTES:\r\n"\r | |
1057 | " 1. The following characters cannot be used in a volume label:\r\n"\r | |
1058 | " % ^ * + = [ ] | : ; \" < > ? / . \r\n"\r | |
1059 | " 2. No spaces are allowed in a volume label.\r\n"\r | |
1060 | " 3. This command displays the volume information for the specified file\r\n"\r | |
1061 | " system. If fs is not specified, the current file system is used.\r\n"\r | |
1062 | " 4. If -n is specified, the volume label for fs is set to\r\n"\r | |
1063 | " VolumeLabel.\r\n"\r | |
1064 | " 5. The maximum length for volume label is 11 characters.\r\n"\r | |
1065 | ".SH EXAMPLES\r\n"\r | |
1066 | " \r\n"\r | |
1067 | "EXAMPLES:\r\n"\r | |
1068 | " * To display the volume of the current file system:\r\n"\r | |
1069 | " fs0:\> vol\r\n"\r | |
1070 | " \r\n"\r | |
1071 | " * To change the label of fs0:\r\n"\r | |
1072 | " Shell> vol fs0 -n help_test\r\n"\r | |
1073 | " \r\n"\r | |
1074 | " * To delete the volume label of fs0:\r\n"\r | |
1075 | " fs0:\> vol fs0 -d\r\n"\r | |
1076 | ".SH RETURNVALUES\r\n"\r | |
1077 | " \r\n"\r | |
1078 | "RETURN VALUES:\r\n"\r | |
1079 | " SHELL_SUCCESS The action was completed as requested.\r\n"\r | |
1080 | " SHELL_INVALID_PARAMETER One of the passed-in parameters was incorrectly\r\n"\r | |
1081 | " formatted or its value was out of bounds.\r\n"\r | |
1082 | " SHELL_SECURITY_VIOLATION This function was not performed due to a security\r\n"\r | |
1083 | " violation.\r\n"\r | |
1084 | " SHELL_NOT_FOUND The target file-system was not found.\r\n"\r | |
1085 | \r |