audk/ShellPkg/Library/UefiShellLevel3CommandsLib/UefiShellLevel3CommandsLib.uni

<EFBFBD><EFBFBD>// /**
//
// Copyright (c) 2013, Hewlett-Packard Development Company, L.P.
// Copyright (c) 2009 - 2013, Intel Corporation. All rights reserved. <BR>
// This program and the accompanying materials
// are licensed and made available under the terms and conditions of the BSD License
// which accompanies this distribution. The full text of the license may be found at
// http://opensource.org/licenses/bsd-license.php
//
// THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
// WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
//
// Module Name:
//
// UefiShellLevel3CommandsLib.uni
//
// Abstract:
//
// String definitions for UEFI Shell 2.0 level 3 commands
//
//
// **/

/=#

#langdef   en-US "en-US"

#string STR_GEN_TOO_MANY          #language en-US "%EError. %NToo many arguments specified.\r\n"
#string STR_GEN_TOO_FEW           #language en-US "%EError. %NToo few arguments specified.\r\n"
#string STR_GEN_PARAM_INV         #language en-US "%EError. %NIncorrect parameter.\r\n"
#string STR_GEN_PROBLEM           #language en-US "%EError. %NThe argument '%B%s%N' is incorrect.\r\n"
#string STR_GEN_NO_VALUE          #language en-US "%EError. %NThe argument '%B%s%N' requires a value.\r\n"
#string STR_GEN_ERR_AD            #language en-US "%EError. %NAccess denied.\r\n"
#string STR_GEN_ERR_UK            #language en-US "%EError: %r\r\n"
#string STR_GEN_PARAM_CON         #language en-US "%EError. %NParameters conflict\r\n"
#string STR_GEN_FILE_OPEN_FAIL    #language en-US "%EError. %NThe file '%B%s%N' did not open.\r\n"
#string STR_GEN_FILE_AD           #language en-US "%EError. %NAccess denied to file '%B%s%N'.\r\n"
#string STR_GEN_CRLF              #language en-US "\r\n"
#string STR_GEN_NO_CWD            #language en-US "No current directory is specified.\r\n"
#string STR_GEN_NO_FILES          #language en-US "No matching files were found.\r\n"
#string STR_GEN_DIR_NF            #language en-US "Directory '%B%s%N' was not found.\r\n"
#string STR_GEN_FILE_NF           #language en-US "File '%B%s%N' was not found.\r\n"
#string STR_GEN_FILE_NO_OPEN      #language en-US "%EError. %N The file '%B%s%N' wouldn't open: %r.\r\n"
#string STR_GEN_IS_DIR            #language en-US "'%B%s%N' is a directory.\r\n"
#string STR_GEN_SCRIPT_ONLY       #language en-US "%EError. %N This command is not allowed outside of scripts.\r\n"

#string STR_TYP_ERROR             #language en-US "Type operation was not successful on '%B%s%N'. %EError. %N%r\r\n."

#string STR_TOUCH_ERROR           #language en-US "Touch operation was not successful on '%B%s%N'. %EError. %N%r\r\n."

#string STR_VER_OUTPUT_SHELL      #language en-US "UEFI %s Shell v%d.%d\r\n"
#string STR_VER_OUTPUT_SIMPLE     #language en-US "%d.%d\r\n"
#string STR_VER_OUTPUT_UEFI       #language en-US "UEFI v%d.%02d (%s, 0x%08x)\r\n"
#string STR_VER_OUTPUT_SUPPLIER   #language en-US "%s\r\n"

#string STR_ECHO_ON               #language en-US "Echo is on.\r\n"
#string STR_ECHO_OFF              #language en-US "Echo is off.\r\n"

#string STR_PAUSE_PROMPT          #language en-US "Enter 'q' to quit, any other key to continue:\r\n"

#string STR_HELP_NF               #language en-US "No help could be found for command '%B%s%N'.\r\n"
#string STR_HELP_INV              #language en-US "The help data for command '%B%s%N' was incorrect format.\r\n"
#string STR_HELP_SC_HEADER        #language en-US "Character    Description\r\n"
                                                  "---------    ---------------------------------------------- \r\n"
#string STR_HELP_SC_DATA          #language en-US "<newline>    Ends a command line.\r\n"
                                                  "<space>      Ends an argument, if it is not in a quotation.\r\n"
                                                  "#            Starts a comment.\r\n"
                                                  ">            Used for output redirection.\r\n"
                                                  "<            Used for input redirection.\r\n"
                                                  "|            Used for pipe command support.\r\n"
                                                  "%            Used to delimit a variable or an argument.\r\n"
                                                  "\"            Used to delimit a quotation.\r\n"
                                                  "^            Prevents the next character from being\r\n"
                                                  "             interpreted as having special meaning.\r\n"
                                                  "             Can be used inside quoted strings.\r\n"
                                                  "*, ?, [, ]   Wildcards to specify multiple similar file names.\r\n"
#string STR_HELP_COMMAND          #language en-US "%H%-14s%N- %s\r\n"
#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"

#string STR_HELP_PAGE_COMMAND     #language en-US "%N%s\r\n"

#string STR_ALIAS_OUTPUT          #language en-US "%1c %10s:%s\r\n"

#string STR_GET_MTC_OUTPUT        #language en-US "%016Lx\r\n"

#string STR_GET_HELP_HELP         #language en-US ""
".TH help 0 "Displays help information from the UEFI Shell."\r\n"
".SH NAME\r\n"
"Displays the UEFI Shell command list or verbose command help.\r\n"
".SH SYNOPSIS\r\n"
"help [cmd | pattern | special] [-usage] [-verbose] [-section sectionname][-b]\r\n"
".SH DESCRIPTION\r\n"
"The help command displays information about one or more shell commands.\r\n"
"If no other options are specified, each command will be displayed along with a brief\r\n"
"description of its function. If -verbose is specified, then all help information for the\r\n"
"specified commands. If -section is specified, only the help section specified will be\r\n"
"displayed (see below). If -usage is specified, then the command, a brief description\r\n"
"and the usage will be displayed.\r\n"
"The help text is gathered from UCS-2 text files found in the directory where the shell\r\n"
"or shell command executable was located. The files have the name commandname.\r\n"
"man, where command-name is the name of the shell command. The files follow\r\n"
"a sub-set of the MAN page format, as described below.\r\n"
"If no option is specified, then only the NAME section of the page is reproduced.\r\n"
".SH OPTIONS\r\n"
"cmd\r\n"
"Command to display help about.\r\n"
"pattern\r\n"
"Pattern which describes the commands to be displayed.\r\n"
"special\r\n"
"Displays a list of the special characters used in the shell command line.\r\n"
"-usage\r\n"
"Display the usage information for the command. The same as specifying -\r\n"
"section:NAME and -section:SYNOPSIS\r\n"
"-section sectionname\r\n"
"Display the specified section of the help information. Standard section names can\r\n"
"be found in Appendix B.\r\n"
".SH EXAMPLES\r\n"
"To display the list of commands in the UEFI Shell and break after one screen:\r\n"
"%EShell>%N help -b\r\n"
"? - Displays commands list or verbose help of a\r\n"
"    command\r\n"
"alias   - Displays, creates, or deletes aliases in the\r\n"
"          UEFI Shell\r\n"
"attrib  - Displays or changes the attributes of files\r\n"
"          or directories\r\n"
"cd      - Displays or changes the current directory\r\n"
"cls     - Clears the standard output with an optional\r\n"
"          background color\r\n"
"connect - Binds an EFI driver to a device and starts\r\n"
"          the driver\r\n"
"copy    - Copies one or more files/directories to\r\n"
"          another location\r\n"
"...\r\n"
"\r\n"
"To display help information of a Shell command - ls:\r\n"
"%EShell>%N help ls\r\n"
"%EShell>%N ? ls\r\n"
"%EShell>%N ls -?\r\n"
"\r\n"
"To display the list of commands that start with character 'p':\r\n"
"%EShell>%N help p*\r\n"
"pause - Prints a message and suspends for keyboard input\r\n"
"\r\n"
".SH RETURNVALUES\r\n"
"0 The help was displayed\r\n"
"1 No command help was displayed\r\n"

#string STR_GET_HELP_ALIAS        #language en-US ""
".TH alias 0 "Handles aliases in the Shell."\r\n"
".SH NAME\r\n"
"Displays, creates, or deletes UEFI Shell aliases.\r\n"
".SH SYNOPSIS\r\n"
"alias [-d|-v] [alias-name] [command-name]\r\n"
".SH DESCRIPTION\r\n"
"This command displays, creates, or deletes aliases in the UEFI Shell environment. An alias provides a new name for an existing UEFI Shell command or UEFI application. Once the alias is created, it can be used to run the command or launch the UEFI application.\r\n"
"There are some aliases that are predefined in the UEFI Shell environment. These aliases provide the MS-DOS and UNIX equivalent names for the file manipulation commands. See Built-In Aliases (section 3.6.4) for more details. \r\n"
"Aliases will be retained even after exiting the shell unless the -v option is specified. If -v is specified then the alias will not be valid after leaving the shell.\r\n"
".SH OPTIONS\r\n"
"alias-name      Alias name\r\n"
"command-name    Original command's name or path.\r\n"
"-d              Delete an alias. command-name must not be specified.\r\n"
"-v              Make the alias volatile.\r\n"
".SH EXAMPLES\r\n"
"To display all aliases in the UEFI Shell environment:\r\n"
"  %EShell>%N alias\r\n"
"  md : mkdir\r\n"
"  rd : rm\r\n"
"\r\n"
"To create an alias in the UEFI Shell environment:\r\n"
"  %EShell>%N alias myguid guid\r\n"
"  %EShell>%N alias\r\n"
"  md : mkdir\r\n"
"  rd : rm\r\n"
"  myguid : guid\r\n"
"\r\n"
"To delete an alias in the UEFI Shell environment:\r\n"
"  %EShell>%N alias -d myguid\r\n"
"  %EShell>%N alias\r\n"
"  md : mkdir\r\n"
"  rd : rm\r\n"
"\r\n"
"To add a volatile alias in the current EFI environment, which has a star * at the line head. This volatile alias will disappear at next boot.\r\n"
"  %EShell>%N alias -v fs0 floppy\r\n"
"  %EShell>%N alias\r\n"
"  md : mkdir\r\n"
"  rd : rm\r\n"
"  * fs0 : floppy\r\n"
".SH RETURNVALUES\r\n"
"SHELL_SUCCESS             The action was completed as requested.\r\n"
"SHELL_INVALID_PARAMETER   One of the passed-in parameters was incorrectly \r\n"
"                          formatted or its value was out of bounds.\r\n"
"SHELL_OUT_OF_RESOURCES    A request to set a variable in a non-volatile fashion\r\n"
"                          could not be completed. The resulting non-volatile \r\n"
"                          request has been converted into a volatile request.\r\n"
"SHELL_SECURITY_VIOLATION  This function was not performed due to a security \r\n"
"                          violation\r\n"

#string STR_GET_HELP_CLS          #language en-US ""
".TH cls 0 "clear screen"\r\n"
".SH NAME\r\n"
"Clears standard output and optionally changes background color.\r\n"
".SH SYNOPSIS\r\n"
"cls [color]\r\n"
".SH DESCRIPTION\r\n"
"This command clears the standard output device with an optional background color attribute. If a color is not specified, then the background color does not change.\r\n"
".SH OPTIONS\r\n"
"color - New background color\r\n"
"        0 - Black\r\n"
"        1 - Blue\r\n"
"        2 - Green\r\n"
"        3 - Cyan\r\n"
"        4 - Red\r\n"
"        5 - Magenta\r\n"
"        6 - Yellow\r\n"
"        7 - Light gray\r\n"
".SH EXAMPLES\r\n"
"To clear standard output without changing the background color:\r\n"
"  fs0:\> cls\r\n"
"To clear standard output and change the background color to cyan:\r\n"
"  fs0:\> cls 3\r\n"
"To clear standard output and change the background to the default color:\r\n"
"  fs0:\> cls 0\r\n"
".SH RETURNVALUES\r\n"
"SHELL_SUCCESS             The action was completed as requested.\r\n"
"SHELL_INVALID_PARAMETER   One of the passed-in parameters was incorrectly \r\n"
"                          formatted or its value was out of bounds.\r\n"
"SHELL_SECURITY_VIOLATION  This function was not performed due to a security\r\n"
"                          violation\r\n"
"SHELL_NOT_FOUND           The requested file was not found.\r\n"

#string STR_GET_HELP_ECHO         #language en-US ""
".TH echo 0 "display text or control text output"\r\n"
".SH NAME\r\n"
"Controls script file command echoing or displays a message.\r\n"
".SH SYNOPSIS\r\n"
"echo [-on|-off]\r\n"
"echo [message]\r\n"
".SH OPTIONS\r\n"
"message   Message to display\r\n"
"-on       Enables display when reading commands from script files.\r\n"
"-off      Disables display when reading commands from script files.\r\n"
".SH DESCRIPTION\r\n"
"The first form of this command controls whether script commands are displayed as they are read from the script file. If no argument is given, the current "on" or "off" status is displayed. The second form prints the given message to the display.\r\n"
".SH RETURNVALUES\r\n"
"SHELL_SUCCESS             The action was completed as requested.\r\n"
"SHELL_SECURITY_VIOLATION  This function was not performed due to a security \r\n"
"                          violation\r\n"
".SH EXAMPLES\r\n"
"To display a message string of 'Hello World':\r\n"
"  fs0:\> echo Hello World\r\n"
"  Hello World\r\n"
"\r\n"
"To turn command echoing on:\r\n"
"  fs0:\> echo -on\r\n"
"\r\n"
"To execute HelloWorld.nsh, and display when reading lines from the script file:\r\n"
"  fs0:\> HelloWorld.nsh\r\n"
"  +HelloWorld.nsh> echo Hello World\r\n"
"  Hello World\r\n"
"\r\n"
"To turn command echoing off:\r\n"
"  fs0:\> echo -off\r\n"
"\r\n"
"To display the current echo setting:\r\n"
"  fs0:\> echo\r\n"
"  Echo is off\r\n"

#string STR_GET_HELP_GETMTC       #language en-US ""
".TH getmtc 0 "gets the MTC count"\r\n"
".SH NAME\r\n"
"Gets the MTC from BootServices and displays it.\r\n"
".SH SYNOPSIS\r\n"
"GetMtc\r\n"
".SH DESCRIPTION\r\n"
"This command displays the current monotonic counter value. The lower 32 bits increment every time this command is executed. Every time the system is reset, the upper 32 bits will be incremented, and the lower 32 bits will be reset to 0. The following example is typical output from help for this command.\r\n"
".SH RETURNVALUES\r\n"
"SHELL_SUCCESS             The action was completed as requested.\r\n"
"SHELL_DEVICE_ERROR        The underlying device was not working correctly.\r\n"
"SHELL_SECURITY_VIOLATION  This function was not performed due to a security \r\n"
"                          violation.\r\n"
".SH EXAMPLES\r\n"
"  fs0:\> getmtc\r\n"
"  100000000\r\n"
"  fs0:\> getmtc\r\n"
"  100000001\r\n"

#string STR_GET_HELP_PAUSE        #language en-US ""
".TH pause 0 "pauses scripts"\r\n"
".SH NAME\r\n"
"Pauses a script and waits for an operator to press a key.\r\n"
".SH SYNOPSIS\r\n"
"pause [-q]\r\n"
".SH OPTIONS\r\n"
"-q          Do not display test output prompt.\r\n"
".SH DESCRIPTION\r\n"
"The pause command prints a message to the display, then suspends script file execution, and waits for keyboard input. Pressing any key resumes execution, except for q or Q. If either q or Q is pressed, script processing terminates; otherwise, execution continues with the next line after the pause command.\r\n"
"The pause command is available only in scripts. Switch -q can hide the message and it's optional.\r\n"
".SH RETURNVALUES\r\n"
"none\r\n"
".SH EXAMPLES\r\n"
"Following script is a sample of 'pause' command:\r\n"
"  fs0:\> type pause.nsh\r\n"
"  #\r\n"
"  # Example script for 'pause' command\r\n"
"  #\r\n"
"  echo pause.nsh begin..\r\n"
"  date\r\n"
"  time\r\n"
"  pause\r\n"
"  echo pause.nsh done.\r\n"
"To execute the script with echo on:\r\n"
"  fs0:\> pause.nsh\r\n"
"  +pause.nsh> echo pause.nsh begin..\r\n"
"  pause.nsh begin..\r\n"
"  +pause.nsh> date\r\n"
"  06/19/2001\r\n"
"  +pause.nsh> time\r\n"
"  00:51:45\r\n"
"  +pause.nsh> pause\r\n"
"  Enter 'q' to quit, or any other key to continue:\r\n"
"  +pause.nsh> echo pause.nsh done.\r\n"
"  pause.nsh done.\r\n"
"To execute the script with echo off:\r\n"
"  fs0:\> echo -off\r\n"
"  fs0:\> pause.nsh\r\n"
"  pause.nsh begin..\r\n"
"  06/19/2001\r\n"
"  00:52:50\r\n"
"  Enter 'q' to quit, or any other key to continue: q\r\n"
"  fs0:\>\r\n"

#string STR_GET_HELP_TOUCH        #language en-US ""
".TH touch 0 "Touch a file to update a directory"\r\n"
".SH NAME\r\n"
"Updates filename timestamp with current system date and time.\r\n"
".SH SYNOPSIS\r\n"
"touch [-r] file [file ...]\r\n"
".SH OPTIONS\r\n"
"file      The name or pattern of the file or directory. There can be multiple \r\n"
"          files on the command-line.\r\n"
"-r        Recurse into subdirectories\r\n"
".SH DESCRIPTION\r\n"
"This command updates to the current time and date the time and date on the file that is specified by the file parameter.\r\n"
"If multiple files are specified on the command line, it will continue processing. It will touch the files one by one and errors will be ignored.\r\n"
"Touch cannot change the time and date of read-only files and directories.\r\n"
".SH RETURNVALUES\r\n"
"SHELL_SUCCESS             The action was completed as requested.\r\n"
"SHELL_NOT_FOUND           The target file or set of files were not found.\r\n"
"SHELL_SECURITY_VIOLATION  This function was not performed due to a security \r\n"
"                          violation\r\n"
"SHELL_WRITE_PROTECTED     The media was write-protected or the file had a \r\n"
"                          read-only attribute associated with it.\r\n"

#string STR_GET_HELP_TYPE         #language en-US ""
".TH type 0 "print a file to StdOut"\r\n"
".SH NAME\r\n"
"Sends the contents of a file to the standard output device.\r\n"
".SH SYNOPSIS\r\n"
"type [-a|-u] file [file...]\r\n"
".SH OPTIONS\r\n"
"file      Name of the file to display.\r\n"
"-a        Display the file as if it is encoded as 8-bit ASCII\r\n"
"-u        Displays the file as if it were encoded as UCS-2 Unicode.\r\n"
".SH DESCRIPTION\r\n"
"This command sends the contents of a file to the standard output device. If no options are used, then the command attempts to automatically detect the file type. If it fails, then UCS-2 is presumed.\r\n"
"If the -a option is specified, the file is sent to the standard output device as a stream of ASCII characters.\r\n"
"If the -u option is specified, the file is sent to the standard output device as a stream of Unicode (UCS-2) characters.\r\n"
".SH RETURNVALUES\r\n"
"SHELL_SUCCESS               The action was completed as requested.\r\n"
"SHELL_INVALID_PARAMETER     One of the passed in parameters was incorrectly \r\n"
"                            formatted or its value was out of bounds.\r\n"
"SHELL_SECURITY_VIOLATION    This function was not performed due to a security \r\n"
"                            violation.\r\n"
"SHELL_NOT_FOUND             The target file or set of files were not found.\r\n"
".SH EXAMPLES\r\n"
"To display a file in UCS-2 format:\r\n"
"  fs0:\> type -u pause.nsh\r\n"
"  #\r\n"
"  # Example script for 'pause' command\r\n"
"  #\r\n"
"  echo pause.nsh begin..\r\n"
"  date\r\n"
"  time\r\n"
"  pause\r\n"
"  echo pause.nsh done.\r\n"
"\r\n"
"To display multiple files:\r\n"
"  fs0:\> type test.*\r\n"
"  How to Install?\r\n"
"  time\r\n"
"  stall 3000000\r\n"
"  time\r\n"

#string STR_GET_HELP_VER          #language en-US ""
".TH ver 0 "prints out version info"\r\n"
".SH NAME\r\n"
"Displays UEFI Firmware version information.\r\n"
".SH SYNOPSIS\r\n"
"ver [-s|-terse]\r\n"
".SH OPTIONS\r\n"
"-s      Displays only the UEFI Shell version.\r\n"
"-terse  Displays only first part of data.\r\n"
".SH DESCRIPTION\r\n"
"This command displays the version information for this EFI Firmware, or the version information for the UEFI Shell itself. The information is retrieved through the EFI System Table or the Shell image.\r\n"
"\r\n"
"UEFI <support-level> Shell v<uefi-shell-version>\r\n"
"shell-supplier-specific-data\r\n"
"UEFI v<uefi-firmware-version> (<firmware vendor name>, 0x<firmware vendor\r\n"
"version as 32-bit hex value> <optional additional vendor version>)\r\n"
"\r\n"
"  UEFI Basic Shell v2.0\r\n"
"  Build 8192. Copyright 2008 by Intel(R) Corporation.\r\n"
"  UEFI v2.10 Firmware (Phoenix Technologies Ltd., 0x01014318)\r\n"
"\r\n"
"<support-level>\r\n"
"  0 = Minimal, 1 = Scripting, 2 = Basic, 3 = Interactive\r\n"
"<uefi-shell-version>\r\n"
"  comes from the shell spec upon which the shell implementation is based.\r\n"
"<shell-supplier-specific-data>\r\n"
"  Build, copyright, etc.\r\n"
"<uefi-firmware-version>\r\n"
"  From the EFI System Table's Hdr.Revision field, formatted as two period\r\n"
"  delimited fields. The first field is the upper 16-bits of this field, \r\n"
"  represented as a decimal unsigned integer. The second field is the lower \r\n"
"  16-bites of this field, represented as a two-digit, zero-filled decimal \r\n"
"  unsigned integer.\r\n"
"<firmware vendor name>\r\n"
"  From the EFI System Table's FirmwareVendor field\r\n"
"<firmware vendor version>\r\n"
"  From the EFI System Table's FIrmwareRevision field\r\n"
".SH RETURNVALUES\r\n"
"SHELL_SUCCESS The action was completed as requested.\r\n"