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