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