mirror of https://github.com/acidanthera/audk.git
988 lines
110 KiB
Plaintext
988 lines
110 KiB
Plaintext
// /**
|
|
//
|
|
// (C) Copyright 2013-2014 Hewlett-Packard Development Company, L.P.
|
|
// Copyright (c) 2009 - 2014, 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:
|
|
//
|
|
// UefiShellLevel2CommandsLib.uni
|
|
//
|
|
// Abstract:
|
|
//
|
|
// String definitions for UEFI Shell 2.0 level 2 commands
|
|
//
|
|
//
|
|
// **/
|
|
|
|
/=#
|
|
|
|
#langdef en-US "english"
|
|
|
|
#string STR_GEN_NO_MEM #language en-US "%EError. %NMemory is not available.\r\n"
|
|
#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_PROBLEM_VAL #language en-US "%EError. %NThe argument '%B%s%N' has incorrect value.\r\n"
|
|
#string STR_GEN_ATTRIBUTE #language en-US "%EError. %NThe argument '%B-a%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_FILE #language en-US "%EError. %NFile '%B%s%N' error: %r\r\n"
|
|
#string STR_GEN_ERR_UK #language en-US "%EError: %N%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' could not be opened.\r\n"
|
|
#string STR_GEN_FILE_CLOSE_FAIL #language en-US "%EError. %NThe file '%B%s%N' could not be closed.\r\n"
|
|
#string STR_GEN_FILE_AD #language en-US "%EError. %NAccess denied to file '%B%s%N'.\r\n"
|
|
#string STR_GEN_FILE_NF #language en-US "%EError. %NFile '%B%s%N' was not found.\r\n"
|
|
#string STR_GEN_CRLF #language en-US "\r\n"
|
|
#string STR_GEN_NO_CWD #language en-US "%EError. %NNo current directory is specified.\r\n"
|
|
#string STR_GEN_NO_FILES #language en-US "%EError. %NNo matching files were found.\r\n"
|
|
#string STR_GEN_DIR_NF #language en-US "%EError. %NDirectory '%B%s%N' was not found.\r\n"
|
|
#string STR_GEN_RES_OK #language en-US "- [ok]\r\n"
|
|
#string STR_GEN_NOT_DIR #language en-US "%EError. %N'%B%s%N' is not a directory.\r\n"
|
|
#string STR_GEN_SFO_HEADER #language en-US "ShellCommand, "%s"\r\n"
|
|
#string STR_GEN_MARG_ERROR #language en-US "%EError. %NThe destination '%B%s%N' is ambigious.\r\n"
|
|
#string STR_GEN_FILE_ERROR #language en-US "%EError. %NThe destination is an existant file '%B%s%N'.\r\n"
|
|
#string STR_GEN_UEFI_FUNC_ERROR #language en-US "%EError. %NThe UEFI function '%B%s%N' returned an incorrect value for: %s (%x).\r\n"
|
|
#string STR_GEN_UEFI_FUNC_WARN #language en-US "%EWarning. %NUEFI function '%B%s%N' returned: %r.\r\n"
|
|
#string STR_GEN_DEST_EXIST_OVR #language en-US "Destination file already exists. Overwrite? %BY%Nes, %BN%No, %BA%Nll, %BC%Nancel "
|
|
#string STR_GEN_CPY_FAIL #language en-US "%EError. %NCopy failure: insufficient capacity on destination media\r\n"
|
|
#string STR_GEN_CPY_READ_ERROR #language en-US "%EError. %NCopy: reading '%B%s%N': IO Error \r\n"
|
|
#string STR_GEN_CPY_WRITE_ERROR #language en-US "%EError. %NCopy: writing '%B%s%N': IO Error \r\n"
|
|
#string STR_GEN_OUT_MEM #language en-US "%EError. %NMemory allocation was not successful.\r\n"
|
|
|
|
#string STR_SET_DISP #language en-US "%V%8s %N= %H%s%N\r\n"
|
|
#string STR_SET_NF #language en-US "%EError. %NEnvironment Variable '%B%s%N' not defined.\r\n"
|
|
#string STR_SET_ND #language en-US "%EError. %NEnvironment Variable '%B%s%N' could not be deleted: %r.\r\n"
|
|
|
|
#string STR_CD_PRINT #language en-US "%s\r\n"
|
|
#string STR_CD_NF #language en-US "%EError. %NNo mapping found\r\n"
|
|
|
|
#string STR_MAP_NF #language en-US "%EError. %NMapping '%B%s%N' not found.\r\n"
|
|
#string STR_MAP_NOF #language en-US "%EError. %NNo mapable target found '%B%s%N'.\r\n"
|
|
#string STR_MAP_SFO_MAPPINGS #language en-US "Mappings, "%s", "%s", "%s"\r\n"
|
|
#string STR_MAP_HEADER #language en-US "%EMapping table%N\r\n"
|
|
#string STR_MAP_ENTRY #language en-US "%E%10s%N %HAlias(s):%N%s\r\n %s\r\n"
|
|
#string STR_MAP_ENTRY_VERBOSE #language en-US " Handle: [%H%02x%N]\r\n"
|
|
" Media Type: %s\r\n"
|
|
" Removable: %s\r\n"
|
|
" Current Dir: %s\r\n"
|
|
|
|
#string STR_ATTRIB_OUTPUT_LINE #language en-US "Attrib: %1c%1c%1c%1c%1c %s\r\n"
|
|
|
|
#string STR_MAP_MEDIA_FLOPPY #language en-US "Floppy"
|
|
#string STR_MAP_MEDIA_UNKNOWN #language en-US "Unknown"
|
|
#string STR_MAP_MEDIA_HARDDISK #language en-US "HardDisk"
|
|
#string STR_MAP_MEDIA_CDROM #language en-US "CD-Rom"
|
|
|
|
#string STR_MKDIR_ALREADY #language en-US "Directory '%B%s%N' already exists.\r\n"
|
|
#string STR_MKDIR_CREATEFAIL #language en-US "Directory '%B%s%N' unable to create.\r\n"
|
|
|
|
#string STR_DATE_FORMAT #language en-US "%02d/%02d/%04d\r\n"
|
|
#string STR_DATE_SFO_FORMAT #language en-US "Date, "%02d", "%02d", "%04d"\r\n"
|
|
|
|
#string STR_TIME_FORMAT #language en-US "%02d:%02d:%02d (UTC%1s%02d:%02d)"
|
|
#string STR_TIME_DST0 #language en-US " DST: Not Affected\r\n"
|
|
#string STR_TIME_DST1 #language en-US " DST: Affected\r\n"
|
|
#string STR_TIME_DST2 #language en-US " DST: Adjusted\r\n"
|
|
#string STR_TIME_DST3 #language en-US " DST: Affected and Adjusted\r\n"
|
|
|
|
#string STR_TIMEZONE_M12 #language en-US "UTC-12:00, International Date Line West\r\n"
|
|
#string STR_TIMEZONE_M11 #language en-US "UTC-11:00, Midway Island, Samoa\r\n"
|
|
#string STR_TIMEZONE_M10 #language en-US "UTC-10:00, Hawaii\r\n"
|
|
#string STR_TIMEZONE_M9 #language en-US "UTC-09:00, Alaska\r\n"
|
|
#string STR_TIMEZONE_M8 #language en-US "UTC-08:00, Pacific Time(US & Canada), Tijuana, Portland\r\n"
|
|
#string STR_TIMEZONE_M7 #language en-US "UTC-07:00, Arizona, Chihuahua, La Paz, Mazatlan, Mountain Time (US & Canada)\r\n"
|
|
#string STR_TIMEZONE_M6 #language en-US "UTC-06:00, Central America, Central Time(US & Canada)\r\n"
|
|
#string STR_TIMEZONE_M5 #language en-US "UTC-05:00, Bogota, Lima, Quito, Eastern Time(US & Canada)\r\n"
|
|
#string STR_TIMEZONE_M430 #language en-US "UTC-04:30, Caracas\r\n"
|
|
#string STR_TIMEZONE_M4 #language en-US "UTC-04:00, Atlantic Time(Canada), Caracas, Santiago\r\n"
|
|
#string STR_TIMEZONE_M330 #language en-US "UTC-03:30, Newfoundland\r\n"
|
|
#string STR_TIMEZONE_M3 #language en-US "UTC-03:00, Brasilia, Buenos Aires, Georgetown, Greenland\r\n"
|
|
#string STR_TIMEZONE_M2 #language en-US "UTC-02:00, Mid-Atlantic\r\n"
|
|
#string STR_TIMEZONE_M1 #language en-US "UTC-01:00, Azores, Cape Verde Is.\r\n"
|
|
#string STR_TIMEZONE_0 #language en-US "UTC , Greenwich Mean Time, Casablanca, Monrovia, Dublin, London\r\n"
|
|
#string STR_TIMEZONE_P1 #language en-US "UTC+01:00, Amsterdam, Berlin, Bern, Rome, Paris, West Central Africa\r\n"
|
|
#string STR_TIMEZONE_P2 #language en-US "UTC+02:00, Athens, Istanbul, Bucharest, Cairo, Jerusalem\r\n"
|
|
#string STR_TIMEZONE_P3 #language en-US "UTC+03:00, Baghdad, Kuwait, Riyadh, Moscow, Nairobi\r\n"
|
|
#string STR_TIMEZONE_P330 #language en-US "UTC+03:30, Tehran\r\n"
|
|
#string STR_TIMEZONE_P4 #language en-US "UTC+04:00, Abu Dhabi, Muscat, Baku, Tbilisi, Yerevan\r\n"
|
|
#string STR_TIMEZONE_P430 #language en-US "UTC+04:30, Kabul\r\n"
|
|
#string STR_TIMEZONE_P5 #language en-US "UTC+05:00, Ekaterinburg, Islamabad, Karachi, Tashkent\r\n"
|
|
#string STR_TIMEZONE_P530 #language en-US "UTC+05:30, Chennai, Kolkata, Mumbai, New Delhi\r\n"
|
|
#string STR_TIMEZONE_P545 #language en-US "UTC+05:45, Kathmandu\r\n"
|
|
#string STR_TIMEZONE_P6 #language en-US "UTC+06:00, Almaty, Novosibirsk, Astana, Dhaka, Sri Jayawardenepura\r\n"
|
|
#string STR_TIMEZONE_P630 #language en-US "UTC+06:30, Rangoon\r\n"
|
|
#string STR_TIMEZONE_P7 #language en-US "UTC+07:00, Bangkok, Hanio, Jakarta, Krasnoyarsk\r\n"
|
|
#string STR_TIMEZONE_P8 #language en-US "UTC+08:00, Beijing, Chongqing, Hong Kong, Urumqi, Taipei, Perth\r\n"
|
|
#string STR_TIMEZONE_P9 #language en-US "UTC+09:00, Osaka, Sapporo, Tokyo, Seoul, Yakutsk\r\n"
|
|
#string STR_TIMEZONE_P930 #language en-US "UTC+09:30, Adelaide, Darwin\r\n"
|
|
#string STR_TIMEZONE_P10 #language en-US "UTC+10:00, Canberra, Melbourne, Sydney, Guam, Hobart, Vladivostok\r\n"
|
|
#string STR_TIMEZONE_P11 #language en-US "UTC+11:00, Magadan, Solomon Is., New Caledonia\r\n"
|
|
#string STR_TIMEZONE_P12 #language en-US "UTC+12:00, Auckland, Wellington, Fiji, Kamchatka, Marshall Is.\r\n"
|
|
#string STR_TIMEZONE_P13 #language en-US "UTC+13:00, Nuku'alofa\r\n"
|
|
#string STR_TIMEZONE_P14 #language en-US "UTC+14:00, Line Islands\r\n"
|
|
#string STR_TIMEZONE_SIMPLE #language en-US "UTC%1s%02d:%02d\r\n"
|
|
#string STR_TIMEZONE_NI #language en-US "No additional information known."
|
|
|
|
#string STR_LOAD_NOT_IMAGE #language en-US "Image '%s' is not an image.\r\n"
|
|
#string STR_LOAD_NOT_DRIVER #language en-US "Image '%s' is not a driver.\r\n"
|
|
#string STR_LOAD_LOADED #language en-US "Image '%s' loaded at %x - %r\r\n"
|
|
#string STR_LOAD_ERROR #language en-US "Image '%s' error in StartImage: %r\r\n"
|
|
|
|
#string STR_LS_LINE_START_ALL #language en-US "%t %5s %1c % ,L11d "
|
|
#string STR_LS_LINE_END_FILE #language en-US "%s\r\n"
|
|
#string STR_LS_LINE_END_EXE #language en-US "%V%s%N\r\n"
|
|
#string STR_LS_LINE_END_DIR #language en-US "%B%s%N\r\n"
|
|
#string STR_LS_FOOTER_LINE #language en-US "% ,L11d File(s) % ,L11d bytes\r\n% ,L11d Dir(s)\r\n"
|
|
#string STR_LS_HEADER_LINE1 #language en-US "Directory of: %H%s%N\r\n"
|
|
#string STR_LS_FILE_NOT_FOUND #language en-US "File Not Found\r\n"
|
|
#string STR_LS_SFO_VOLINFO #language en-US "VolumeInfo,"%s","%,Ld","%5s","%,Ld","%,Ld"\r\n"
|
|
#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"
|
|
|
|
#string STR_VOL_VOLINFO #language en-US "Volume %s (%s)\r\n"
|
|
"%Ld bytes total disk space\r\n"
|
|
"%Ld bytes available on disk\r\n"
|
|
"%d bytes in each allocation unit\r\n"
|
|
|
|
#string STR_RM_LOG_DELETE_CONF #language en-US "Remove Subtree '%B%s%N' [y/n]?"
|
|
#string STR_RM_LOG_DELETE #language en-US "Deleting '%B%s%N'\r\n"
|
|
#string STR_RM_LOG_DELETE_ERR #language en-US "Delete error: %r\r\n"
|
|
#string STR_RM_LOG_DELETE_ERR2 #language en-US "Delete error. Coundn't open file: %r\r\n"
|
|
#string STR_RM_LOG_DELETE_ERR3 #language en-US "Delete error. Invalid target '%B%s%N'\r\n"
|
|
#string STR_RM_LOG_DELETE_COMP #language en-US "Delete successful\r\n"
|
|
#string STR_RM_LOG_DETELE_RO #language en-US "%EError. %N'%B%s%N' is read-only.\r\n"
|
|
|
|
#string STR_MV_OUTPUT #language en-US "Moving %s -> %s\r\n"
|
|
#string STR_MV_INV_SUB #language en-US "%EError. %NCannot move a directory into itself or its subdirectory.\r\n"
|
|
#string STR_MV_INV_RO #language en-US "%EError. %NCannot move a read-only File or Directory '%B%s%N'\r\n"
|
|
#string STR_MV_INV_CWD #language en-US "%EError. %NCannot move current working directory or its subdirectory.\r\n"
|
|
#string STR_MV_INV_FS #language en-US "%EError. %NCannot move between file systems.\r\n"
|
|
|
|
#string STR_CP_OUTPUT #language en-US "Copying %s -> %s\r\n"
|
|
#string STR_CP_ERROR #language en-US "%EError. %NCould not copy: %r\r\n"
|
|
#string STR_CP_DIR_REQ #language en-US "%EError. %NCopying a directory requires -r.\r\n"
|
|
#string STR_CP_DIR_WNF #language en-US "%EError. %NThe specified path does not exist.\r\n"
|
|
#string STR_CP_SD_SAME #language en-US "%EError. %NThe source and destination are the same.\r\n"
|
|
#string STR_CP_SD_PARENT #language en-US "%EError. %NThe destination is a parent of the source.\r\n"
|
|
#string STR_CP_DEST_ERROR #language en-US "%EError. %NThe destination is read-only.\r\n"
|
|
#string STR_CP_DEST_OPEN_FAIL #language en-US "%EError. %NThe destination file '%B%s%N' failed to open with create.\r\n"
|
|
#string STR_CP_DEST_DIR_FAIL #language en-US "%EError. %NThe destination directory '%B%s%N' could not be created.\r\n"
|
|
|
|
#string STR_GET_HELP_ATTRIB #language en-US ""
|
|
".TH attrib 0 "change file attributes"\r\n"
|
|
".SH NAME\r\n"
|
|
"Displays or changes the attributes of files or directories.\r\n"
|
|
".SH SYNOPSIS\r\n"
|
|
"attrib [+a|-a] [+s|-s] [+h|-h] [+r|-r] [file...] [directory...]\r\n"
|
|
".SH OPTIONS\r\n"
|
|
"+a|-a Set or clear the 'archive' attribute\r\n"
|
|
"+s|-s Set or clear the 'system' attribute\r\n"
|
|
"+h|-h Set or clear the 'hidden' attribute\r\n"
|
|
"+r|-r Set or clear the 'read-only' attribute\r\n"
|
|
"file File name (wild cards are permitted)\r\n"
|
|
"directory Directory name (wildcards are permitted)\r\n"
|
|
".SH DESCRIPTION\r\n"
|
|
"four attribute types are supported in the UEFI file system:\r\n"
|
|
" Archive [A]\r\n"
|
|
" System [S]\r\n"
|
|
" Hidden [H]\r\n"
|
|
" Read only [R]\r\n"
|
|
"If a file (in general meaning) is a directory, then it is also shown to have the attribute\r\n"
|
|
"[D].\r\n"
|
|
"If any file in the file list that is specified in the command line does not exist, attrib\r\n"
|
|
"will continue processing the remaining files while reporting the error.\r\n"
|
|
"If no file or directory is specified, then all of the files in the current directory are\r\n"
|
|
"displayed.\r\n"
|
|
"If no attribute is specified, then the attributes of the files will be displayed.\r\n"
|
|
".SH RETURNVALUES\r\n"
|
|
"SHELL_SUCCESS The action was completed as requested.\r\n"
|
|
"SHELL_NOT_FOUND The requested file was not found.\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_WRITE_PROTECTED The media that the action was to take place on is \r\n"
|
|
" write-protected.\r\n"
|
|
".SH EXAMPLES\r\n"
|
|
"To display the attributes of a directory:\r\n"
|
|
" fs0:\> attrib fs0:\\r\n"
|
|
" attrib:D fs0:\\r\n"
|
|
"To display the attributes of all files and sub-directories in the current directory:\r\n"
|
|
" fs0:\> attrib *\r\n"
|
|
" attrib: AS fs0:\serial.efi\r\n"
|
|
" attrib:DA fs0:\test1\r\n"
|
|
" attrib: A HR fs0:\bios.inf\r\n"
|
|
" attrib: A fs0:\VerboseHelp.txt\r\n"
|
|
" attrib: AS fs0:\IsaBus.efi\r\n"
|
|
"To add the system attribute to all files with extension '.efi':\r\n"
|
|
" fs0:\> attrib +s *.efi\r\n"
|
|
"To remove the read only attribute from all files with extension '.inf':\r\n"
|
|
" fs0:\> attrib -r *.inf\r\n"
|
|
" attrib: A H fs0:\bios.inf\r\n"
|
|
|
|
#string STR_GET_HELP_CD #language en-US ""
|
|
".TH cd 0 "changes the current directory"\r\n"
|
|
".SH NAME\r\n"
|
|
"Displays or changes the current directory.\r\n"
|
|
".SH SYNOPSIS\r\n"
|
|
"cd [path]\r\n"
|
|
".SH OPTIONS\r\n"
|
|
"path The relative or absolute directory path.\r\n"
|
|
".SH DESCRIPTION\r\n"
|
|
"This command changes the current working directory that is used by the UEFI Shell environment. If a file system mapping is specified, then the current working directory is changed for that device. Otherwise, the current working directory is changed for the current device.\r\n"
|
|
"If path is not present, then the current working directory (including file system mapping) is displayed to standard out.\r\n"
|
|
"The table below describes the conventions that are used to refer to the directory, its parent, and the root directory in the UEFI Shell environment.\r\n"
|
|
"Convention Description\r\n"
|
|
" . Refers to the current directory.\r\n"
|
|
" .. Refers to the directory's parent.\r\n"
|
|
" \ Refers to the root of the current file system.\r\n"
|
|
"The current working directory is maintained in the environment variable %cwd%.\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"
|
|
"SHELL_INVALID_PARAMETER One of the passed in parameters was incorrectly \r\n"
|
|
" formatted or its value was out of bounds.\r\n"
|
|
".SH EXAMPLES\r\n"
|
|
"To change the current filesystem to the mapped fs0 filesystem:\r\n"
|
|
" %EShell>%N fs0:\r\n"
|
|
"To change the current directory to subdirectory 'efi':\r\n"
|
|
" fs0:\> cd efi\r\n"
|
|
"To change the current directory to the parent directory (fs0:\):\r\n"
|
|
" fs0:\efi\> cd ..\r\n"
|
|
"To change the current directory to 'fs0:\efi\tools':\r\n"
|
|
" fs0:\> cd efi\tools\r\n"
|
|
"To change the current directory to the root of the current FS (FS0):\r\n"
|
|
" fs0:\efi\tools\> cd \\r\n"
|
|
" fs0:\>\r\n"
|
|
"To move between volumes and maintain the current path.\r\n"
|
|
" fs0:\> cd \efi\tools\r\n"
|
|
" fs0:\efi\tools\> fs1:\r\n"
|
|
" fs1:\> cd tmp\r\n"
|
|
" fs1:\tmp> cp fs0:*.* .\r\n"
|
|
" copies all of files in fs0:\efi\tools into fs1:\tmp directory\r\n"
|
|
|
|
#string STR_GET_HELP_CP #language en-US ""
|
|
".TH cp 0 "copies files or directories"\r\n"
|
|
".SH NAME\r\n"
|
|
"Copies one or more files or directories to another location.\r\n"
|
|
".SH SYNOPSIS\r\n"
|
|
"cp [-r] [-q] src [src...] [dst]\r\n"
|
|
".SH OPTIONS\r\n"
|
|
"src Source file/directory name (wildcards are permitted)\r\n"
|
|
"dst Destination file/directory name (wildcards are not permitted). \r\n"
|
|
" If not specified, then the current working directory is assumed \r\n"
|
|
" to be the destination. If there are more than one directory \r\n"
|
|
" specified, then the last is always assumed to be the destination.\r\n"
|
|
"-r Recursive copy.\r\n"
|
|
"-q Quiet copy (no prompt)\r\n"
|
|
".SH DESCRIPTION\r\n"
|
|
"This command copies one or more source files or directories to a destination. If the source is a directory, the -r flag must be specified. If -r is specified, then the source directory will be recursively copied to the destination (which means that all subdirectories will be copied). If a destination is not specified, then the current working directory is assumed to be the destination.\r\n"
|
|
"If any target file (not directory) already exists, there will be a prompt asking the user to confirm replacing the file. The following four choices are available:\r\n"
|
|
" Yes: Replace the file.\r\n"
|
|
" No: Do not replace the file.\r\n"
|
|
" All: Replace the existing files in all subsequent cases.\r\n"
|
|
" Cancel: Do not replace any existing files in all subsequent cases.\r\n"
|
|
"If there are multiple source files/directories, the destination must be a directory.\r\n"
|
|
"If an error occurs, then the copying process will stop immediately.\r\n"
|
|
"When executing in a script, the default is -q.\r\n"
|
|
"When copying to another directory, the directory must already exist.\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 There was insufficient space to save the \r\n"
|
|
" requested file at the destination.\r\n"
|
|
"SHELL_SECURITY_VIOLATION This function was not performed due to a security \r\n"
|
|
" violation\r\n"
|
|
"SHELL_WRITE_PROTECTED An attempt was made to create a file on media that \r\n"
|
|
" was writeprotected.\r\n"
|
|
".SH EXAMPLES\r\n"
|
|
"Note:\r\n"
|
|
"'-r' must be specified if src is a directory. If '-r' is\r\n"
|
|
" specified, then the source directory will be recursively \r\n"
|
|
" copied to the destination.\r\n"
|
|
" Src itself will be copied. ????\r\n"
|
|
"To display the contents of current directory first of all:\r\n"
|
|
" fs0:\> ls\r\n"
|
|
" Directory of: fs0:\\r\n"
|
|
" 06/18/01 01:02p <DIR> 512 efi\r\n"
|
|
" 06/18/01 01:02p <DIR> 512 test1\r\n"
|
|
" 06/18/01 01:02p <DIR> 512 test2\r\n"
|
|
" 06/13/01 10:00a 28,739 IsaBus.efi\r\n"
|
|
" 06/13/01 10:00a 32,838 IsaSerial.efi\r\n"
|
|
" 06/18/01 08:04p 29 temp.txt\r\n"
|
|
" 06/18/01 08:05p <DIR> 512 test\r\n"
|
|
" 3 File(s) 61,606 bytes\r\n"
|
|
" 4 Dir(s)\r\n"
|
|
"To copy a file in the same directory, but change the file name:\r\n"
|
|
" fs0:\> cp temp.txt readme.txt\r\n"
|
|
" copying fs0:\temp.txt -> fs0:\readme.txt\r\n"
|
|
" - [ok]\r\n"
|
|
"To copy multiple files to another directory:\r\n"
|
|
" fs0:\> cp temp.txt isaBus.efi \test\r\n"
|
|
" copying fs0:\temp.txt -> fs0:\test\temp.txt\r\n"
|
|
" - [ok]\r\n"
|
|
" copying fs0:\isaBus.efi -> fs0:\test\IsaBus.efi\r\n"
|
|
" - [ok]\r\n"
|
|
"To copy multiple directories recursively to another directory:\r\n"
|
|
" fs0:\> cp -r test1 test2 boot \test\r\n"
|
|
" copying fs0:\test1 -> fs0:\test\test1\r\n"
|
|
" copying fs0:\test1\test1.txt -> fs0:\test\test1\test1.txt\r\n"
|
|
" - [ok]\r\n"
|
|
" copying fs0:\test2 -> fs0:\test\test2\r\n"
|
|
" copying fs0:\test2\test2.txt -> fs0:\test\test2\test2.txt\r\n"
|
|
" - [ok]\r\n"
|
|
" copying fs0:\boot -> fs0:\test\boot\r\n"
|
|
" copying fs0:\boot\shell.efi -> fs0:\test\boot\shell.efi\r\n"
|
|
" - [ok]\r\n"
|
|
"To see the results of the above operations:\r\n"
|
|
" fs0:\> ls \test\r\n"
|
|
" Directory of: fs0:\test\r\n"
|
|
" 06/18/01 01:01p <DIR> 512 .\r\n"
|
|
" 06/18/01 01:01p <DIR> 0 ..\r\n"
|
|
" 01/28/01 08:21p <DIR> 512 test1\r\n"
|
|
" 01/28/01 08:21p <DIR> 512 test2\r\n"
|
|
" 01/28/01 08:21p <DIR> 512 boot\r\n"
|
|
" 01/28/01 08:23p 29 temp.txt\r\n"
|
|
" 01/28/01 08:23p 28,739 IsaBus.efi\r\n"
|
|
" 2 File(s) 28,828 bytes\r\n"
|
|
" 5 Dir(s)\r\n"
|
|
" %EShell>%N\r\n"
|
|
|
|
#string STR_GET_HELP_MAP #language en-US ""
|
|
".TH map 0 "display or change file mappings"\r\n"
|
|
".SH NAME\r\n"
|
|
"Displays or defines mappings.\r\n"
|
|
".SH SYNOPSIS\r\n"
|
|
"map [-d <sname>]\r\n"
|
|
"map [[-r][-v][-c][-f][-u][-t <type[,type...]>][sname]]\r\n"
|
|
"map [sname handle | mapping]\r\n"
|
|
".SH OPTIONS\r\n"
|
|
"sname MappingMapped name\r\n"
|
|
"handle The number of handle, which is same as dumped from 'dh'\r\n"
|
|
"mapping The device's mapped name. Use this parameter to assign a new \r\n"
|
|
" mapping to a device. The mapping must end with a ':'.\r\n"
|
|
"-sfo Output will be formatted according to "Standard-Format Output" \r\n"
|
|
" below.\r\n"
|
|
"-t Shows the device mappings, filtered according to the device type. \r\n"
|
|
" The supported types are fp (floppy), hd (hard disk) and cd (CD-ROM).\r\n"
|
|
" Types can be combined by putting a comma between two types. Spaces \r\n"
|
|
" are not allowed between types.\r\n"
|
|
"-d Deletes a mapping\r\n"
|
|
"-r Resets to default mappings\r\n"
|
|
"-v Lists verbose information about all mappings.\r\n"
|
|
"-c Shows the consistent mapping.\r\n"
|
|
"-f Shows the normal mapping (not the consistent mapping).\r\n"
|
|
"-u This option will add mappings for newly installed devices and \r\n"
|
|
" remove mappings for uninstalled devices but will not change \r\n"
|
|
" the mappings of existing devices. The user-defined mappings are \r\n"
|
|
" also preserved.\r\n"
|
|
".SH DESCRIPTION\r\n"
|
|
"This command creates a mapping between a user-defined name and a device. The most common use of this command is to create a the mapped name for devices that support a file system protocol. Once these mappings are created, the names can be used with all the file manipulation commands.\r\n"
|
|
"The UEFI Shell environment creates default mappings for all of the devices that support a recognized file system.\r\n"
|
|
"This command can be used to create additional mappings, or it can be used to delete an existing mapping with the -d option. If the map command is used without any parameters, all of the current mappings will be listed. If the -v option is used, the mappings will be shown with additional information about each device.\r\n"
|
|
"The -r option is used to reset all the default mappings in a system; this option is useful if the system configuration has changed since the last boot.\r\n"
|
|
"The -u option will add mappings for newly installed devices and remove mappings for uninstalled devices but will not change the mappings of existing devices. The userdefined mappings are also preserved. A mapping history will be saved so that the original mapping name is used for a device with a specific device path if that mapping name was used for that device path last time. The current directory is also preserved if the current device is not changed.\r\n"
|
|
"Each device in the system has a consistent mapping. If the hardware configuration has not changed, the device's consistent mappings do not change. If two or more machines have the same hardware configurations, the device's consistent mapping will be the same. Use the -c option to list all the consistent mappings in the system.\r\n"
|
|
"The mapping consist of digits and characters. Other characters are illegal.\r\n"
|
|
"This command support wildcards. You can use the wildcards to delete or show the mapping . However, when you assign the mapping, wildcards are forbidden.\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"
|
|
"SHELL_INVALID_PARAMETER One of the passed in parameters was incorrectly \r\n"
|
|
" formatted or its value was out of bounds.\r\n"
|
|
|
|
#string STR_GET_HELP_MKDIR #language en-US ""
|
|
".TH mkdir 0 "creates directories"\r\n"
|
|
".SH NAME\r\n"
|
|
"Creates one or more new directories.\r\n"
|
|
".SH SYNOPSIS\r\n"
|
|
"mkdir dir [dir...]\r\n"
|
|
".SH OPTIONS\r\n"
|
|
"dir Name of directory or directories to be created. Wildcards \r\n"
|
|
" are not allowed.\r\n"
|
|
".SH DESCRIPTION\r\n"
|
|
"This command creates one or more new directories. If dir includes nested directories, then parent directories will be created before child directories. If the directory already exists, then the command will exit with an error.\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 There was insufficient space on the destination \r\n"
|
|
" to create the requested directory.\r\n"
|
|
"SHELL_SECURITY_VIOLATION This function was not performed due to a security \r\n"
|
|
" violation SHELL_WRITE_PROTECTED An attempt was made \r\n"
|
|
" to create a directory when the target media was \r\n"
|
|
" write-protected.\r\n"
|
|
".SH EXAMPLES\r\n"
|
|
"To create a new directory:\r\n"
|
|
" fs0:\> mkdir rafter\r\n"
|
|
" fs0:\> ls\r\n"
|
|
" Directory of: fs0:\\r\n"
|
|
" 06/18/01 08:05p <DIR> 512 test\r\n"
|
|
" 06/18/01 11:14p r 29 readme.txt\r\n"
|
|
" 06/18/01 11:50p <DIR> 512 rafter\r\n"
|
|
" 1 File(s) 211 bytes\r\n"
|
|
" 2 Dir(s)\r\n"
|
|
"To create multiple directories:\r\n"
|
|
" fs0:\> mkdir temp1 temp2\r\n"
|
|
" fs0:\> ls\r\n"
|
|
" Directory of: fs0:\\r\n"
|
|
" 06/18/01 08:05p <DIR> 512 test\r\n"
|
|
" 06/18/01 11:14p r 29 readme.txt\r\n"
|
|
" 06/18/01 11:50p <DIR> 512 rafter\r\n"
|
|
" 06/18/01 11:52p <DIR> 512 temp1\r\n"
|
|
" 06/18/01 11:52p <DIR> 512 temp2\r\n"
|
|
" 1 File(s) 211 bytes\r\n"
|
|
" 4 Dir(s)\r\n"
|
|
|
|
#string STR_GET_HELP_MV #language en-US ""
|
|
".TH mv 0 "move files"\r\n"
|
|
".SH NAME\r\n"
|
|
"Moves one or more files to a destination within a file system.\r\n"
|
|
".SH SYNOPSIS\r\n"
|
|
"mv src [src...] [dst]\r\n"
|
|
".SH OPTIONS\r\n"
|
|
"src Source file/directory name (wildcards are permitted)\r\n"
|
|
"dst Destination file/directory name (wildcards are permitted). If not \r\n"
|
|
" specified, then the current working directory is assumed to be the\r\n"
|
|
" destination. If there is more than one argument on the command line,\r\n"
|
|
" the last one will always be considered the destination.\r\n"
|
|
".SH DESCRIPTION\r\n"
|
|
"This command moves one or more files to a destination within a file system. Moving between filesystem volumes is not supported. If the destination is an existing directory, then the sources are moved into that directory. Otherwise, the sources are moved to the destination, as if the directory has been renamed. If a destination is not specified, the current directory is assumed to be the destination.\r\n"
|
|
"Attempting to move a read-only file/directory will result in an error. Moving a directory that contains read-only files is allowed. You cannot move a directory into itself or its subdirectories. You cannot move a directory if the current working directory is itself or its subdirectories.\r\n"
|
|
"If an error occurs, the remaining files or directories will still be moved.\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"
|
|
"SHELL_INVALID_PARAMETER One of the passed in parameters was incorrectly \r\n"
|
|
" formatted or its value was out of bounds.\r\n"
|
|
"SHELL_NOT_FOUND The source file was not able to be found\r\n"
|
|
"SHELL_OUT_OF_RESOURCES There was insufficient free space to move the \r\n"
|
|
" requested file to its destination.\r\n"
|
|
"SHELL_WRITE_PROTECTED An attempt was made to create a file on media that \r\n"
|
|
" was writeprotected.\r\n"
|
|
".SH EXAMPLES\r\n"
|
|
"To rename a file:\r\n"
|
|
" fs0:\> mv IsaBus.efi Bus.efi\r\n"
|
|
" moving fs0:\IsaBus.efi -> \Bus.efi\r\n"
|
|
" - [ok]\r\n"
|
|
|
|
#string STR_GET_HELP_PARSE #language en-US ""
|
|
".TH parse 0 "parses standard format output files"\r\n"
|
|
".SH NAME\r\n"
|
|
"Retrieves a value from a record output in a standard format.\r\n"
|
|
".SH SYNOPSIS\r\n"
|
|
"parse filename tablename column [-i <Instance>] [-s <Instance>]\r\n"
|
|
".SH OPTIONS\r\n"
|
|
"filename Source file name\r\n"
|
|
"tablename The name of the table being parsed.\r\n"
|
|
"column The one-based column index to use to determine which value \r\n"
|
|
" from a particular record to parse.\r\n"
|
|
"-i <Instance> Start parsing with the nth instance of specified tablename, \r\n"
|
|
" after the specified instance of ShellCommand. If not present,\r\n"
|
|
" then all instances will be returned.\r\n"
|
|
"-s <Instance> Start parsing with the nth instance of the ShellCommand table.\r\n"
|
|
" If not present, then 1 is assumed.\r\n"
|
|
".SH DESCRIPTION\r\n"
|
|
"This command will enable the parsing of data from a file which contains data which has been output from a command having used the -sfo parameter. Since the standard formatted output has a well known means of parsing, this command is intended to be used as a simplified means of having scripts consume such constructed output files and use this retrieved data in logic of the scripts being written for the UEFI shell.\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"
|
|
"SHELL_INVALID_PARAMETER One of the passed in parameters was incorrectly \r\n"
|
|
" formatted or its value was out of bounds.\r\n"
|
|
"SHELL_NOT_FOUND The source file was not able to be found\r\n"
|
|
".SH EXAMPLES\r\n"
|
|
"The following data is contained in a temporary file (temp.txt):\r\n"
|
|
"VolumeInfo, "MikesVolume","400000000","32000000","16000000"\r\n"
|
|
"FileInfo, "fs0:/efi/boot/winloader.efi","45670","arsh"\r\n"
|
|
"FileInfo, "fs0:/efi/boot/mikesfile.txt","1250","a"\r\n"
|
|
"FileInfo, "fs0:/efi/boot/readme.txt","795","a"\r\n"
|
|
"The following shows the parse command being used:\r\n"
|
|
"MikesVolume\r\n"
|
|
"Below is an example using the Index parameter:\r\n"
|
|
"fs0:\> parse temp.txt FileInfo 3 -i 3\r\n"
|
|
"795\r\n"
|
|
|
|
#string STR_GET_HELP_RESET #language en-US ""
|
|
".TH reset 0 "reset the system"\r\n"
|
|
".SH NAME\r\n"
|
|
"Resets the system.\r\n"
|
|
".SH SYNOPSIS\r\n"
|
|
"reset [-w [string]]\r\n"
|
|
"reset [-s [string]]\r\n"
|
|
"reset [-c [string]]\r\n"
|
|
".SH OPTIONS\r\n"
|
|
"-s Performs a shutdown\r\n"
|
|
"-w Performs a warm boot\r\n"
|
|
"-c Performs a cold boot\r\n"
|
|
"string String to be passed to reset service\r\n"
|
|
".SH DESCRIPTION\r\n"
|
|
"This command resets the system. The default is to perform a cold reset unless the -w parameter is specified. If the reset string is specified, then it is passed into the Reset() function, so the system can know the reason for the system reset.\r\n"
|
|
".SH RETURNVALUES\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"
|
|
|
|
#string STR_GET_HELP_RM #language en-US ""
|
|
".TH rm 0 "removes a file or directory"\r\n"
|
|
".SH NAME\r\n"
|
|
"Deletes one or more files or directories.\r\n"
|
|
".SH SYNOPSIS\r\n"
|
|
"rm [-q] file/directory [file/directory ...]\r\n"
|
|
".SH OPTIONS\r\n"
|
|
"-q Quiet mode; does not prompt user for a confirmation\r\n"
|
|
"file File name (wildcards are permitted)\r\n"
|
|
"directory Directory name (wildcards are permitted)\r\n"
|
|
".SH DESCRIPTION\r\n"
|
|
"This command deletes one or more files or directories. If the target is a directory, it will delete the directory, including all its subdirectories. It is not allowed to redirect a file whose parent directory (or the file itself) is being deleted.\r\n"
|
|
"Removing a read-only file/directory will result in a failure. Removing a directory containing read-only file(s) will result in a failure. If an error occurs, rm will exit immediately and later files/directories will not be removed.\r\n"
|
|
"You cannot remove a directory when the current directory is itself or its subdirectory. If file contains wildcards, it will not ask user for confirmation.\r\n"
|
|
"You cannot remove the root directory. You cannot remove the current directory or its ancestor.\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"
|
|
"SHELL_NOT_FOUND The source file was not able to be found\r\n"
|
|
"SHELL_WRITE_PROTECTED The target was writeprotected.\r\n"
|
|
".SH EXAMPLES\r\n"
|
|
"To remove multiple directories at a time:\r\n"
|
|
" fs0:\> ls test\r\n"
|
|
" Directory of: fs0:\test\r\n"
|
|
" 06/18/01 01:01p <DIR> 512 .\r\n"
|
|
" 06/18/01 01:01p <DIR> 0 ..\r\n"
|
|
" 06/19/01 12:59a <DIR> 512 temp1\r\n"
|
|
" 06/19/01 12:59a <DIR> 512 temp2\r\n"
|
|
" 0 File(s) 0 bytes\r\n"
|
|
" 4 Dir(s)\r\n"
|
|
"Error occurs and RM will exit:\r\n"
|
|
" fs0:\> rm test\temp11 temp2\r\n"
|
|
" rm/del: Cannot find 'fs0:\test\temp11' - Not Found\r\n"
|
|
"To remove multiple directories with wildcards:\r\n"
|
|
" fs0:\> rm test\temp*\r\n"
|
|
" rm/del: Remove subtree 'fs0:\test\temp1' [y/n]? y\r\n"
|
|
" removing fs0:\test\temp1\temp1.txt\r\n"
|
|
" - [ok]\r\n"
|
|
" removing fs0:\test\temp1\boot\nshell.efi\r\n"
|
|
" - [ok]\r\n"
|
|
" removing fs0:\test\temp1\boot\r\n"
|
|
" - [ok]\r\n"
|
|
" removing fs0:\test\temp1\r\n"
|
|
" - [ok]\r\n"
|
|
" rm/del: Remove subtree 'fs0:\test\temp2' [y/n]? y\r\n"
|
|
" removing fs0:\test\temp2\temp2.txt\r\n"
|
|
" - [ok]\r\n"
|
|
" removing fs0:\test\temp2\r\n"
|
|
" - [ok]\r\n"
|
|
"Removing a directory that contains a read-only file will fail:\r\n"
|
|
" fs0:\> attrib +r test\temp1\readme.txt\r\n"
|
|
" A R fs0:\test\temp1\readme.txt\r\n"
|
|
" fs0:\> rm test\temp1\r\n"
|
|
" rm/del: Cannot open 'readme.txt' under 'fs0:\test\temp1' in\r\n"
|
|
" writable mode\r\n"
|
|
" - [error] - Access Denied\r\n"
|
|
" Exit status code: Access Denied\r\n"
|
|
|
|
#string STR_GET_HELP_SET #language en-US ""
|
|
".TH set 0 "sets or displays environment variables"\r\n"
|
|
".SH NAME\r\n"
|
|
"Displays or modifies UEFI Shell environment variables.\r\n"
|
|
".SH SYNOPSIS\r\n"
|
|
"set [-v] [sname [value]]\r\n"
|
|
"set [-d <sname>]\r\n"
|
|
".SH OPTIONS\r\n"
|
|
"-d Deletes the environment variable\r\n"
|
|
"-v Volatile variable\r\n"
|
|
"sname Environment variable name\r\n"
|
|
"value Environment variable value\r\n"
|
|
".SH DESCRIPTION\r\n"
|
|
"This command is used to maintain the UEFI Shell environment variables. This command can do the following:\r\n"
|
|
" Display the environment variables.\r\n"
|
|
" Create new environment variables.\r\n"
|
|
" Change the value of existing environment variables.\r\n"
|
|
" Delete environment variables.\r\n"
|
|
"The set command will set the environment variable that is specified by sname to value. This command can be used to create a new environment variable or to modify an existing environment variable.\r\n"
|
|
"If the set command is used without any parameters, then all the environment variables are displayed. If the set command is used with the -d option, then the environment variable that is specified by sname will be deleted.\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"
|
|
"SHELL_OUT_OF_RESOURCES A request to set a variable in a non-volatile \r\n"
|
|
" fashion could not be completed. The resulting \r\n"
|
|
" non-volatile request has been converted into a \r\n"
|
|
" volatile request.\r\n"
|
|
".SH EXAMPLES\r\n"
|
|
"To add an environment variable:\r\n"
|
|
" %EShell>%N set DiagnosticPath fs0:\efi\diag;fs1:\efi\diag\r\n"
|
|
" To display environment variables:\r\n"
|
|
" %EShell>%N set\r\n"
|
|
" path : .\r\n"
|
|
" diagnosticPath : fs0:\efi1.1\diag;fs1:\efi1.1\diag\r\n"
|
|
"To delete an environment variable:\r\n"
|
|
" %EShell>%N set -d diagnosticpath\r\n"
|
|
" %EShell>%N set\r\n"
|
|
" path : .\r\n"
|
|
"To change an environment variable:\r\n"
|
|
" fs0:\> set src efi\r\n"
|
|
" fs0:\> set\r\n"
|
|
" path : .;fs0:\efi\tools;fs0:\efi\boot;fs0:\\r\n"
|
|
" src : efi\r\n"
|
|
" fs0:\> set src efi1.1\r\n"
|
|
" fs0:\> set\r\n"
|
|
" path : .;fs0:\efi\tools;fs0:\efi\boot;fs0:\\r\n"
|
|
" src : efi1.1\r\n"
|
|
"To append an environment variable:\r\n"
|
|
" %EShell>%N set\r\n"
|
|
" path : .\r\n"
|
|
" %EShell>%N set path %path%;fs0:\efi\tools;fs0:\efi\boot;fs0:\\r\n"
|
|
" %EShell>%N set\r\n"
|
|
" path : .;fs0:\efi\tools;fs0:\efi\boot;fs0:\\r\n"
|
|
"To set a volatile variable that will disappear at the next\r\n"
|
|
" boot:\r\n"
|
|
" %EShell>%N set -v EFI_SOURCE c:\project\EFI1.1\r\n"
|
|
" %EShell>%N set\r\n"
|
|
" path : .;fs0:\efi\tools;fs0:\efi\boot;fs0:\\r\n"
|
|
" EFI_SOURCE : c:\project\EFI1.1\r\n"
|
|
|
|
#string STR_GET_HELP_DATE #language en-US ""
|
|
".TH date 0 "set and view the date."\r\n"
|
|
".SH NAME\r\n"
|
|
"Displays and sets the current date for the system.\r\n"
|
|
".SH SYNOPSIS\r\n"
|
|
"date [mm/dd/[yy]yy][-sfo]\r\n"
|
|
".SH OPTIONS\r\n"
|
|
"mm Month of the date to be set (1-12)\r\n"
|
|
"dd Day of the date to be set (1-31)\r\n"
|
|
"yy/yyyy Year of the date to be set. If only two digits, then 9x = 199x, \r\n"
|
|
" otherwise 20xx.\r\n"
|
|
"-sfo Standard-format output. See "Related Definitions" below.\r\n"
|
|
".SH DESCRIPTION\r\n"
|
|
"This command displays and/or sets the current date for the system. If no parameters are used, it shows the current date. If a valid month, day, and year are provided, then the system's date will be updated. Detailed rules are listed below:\r\n"
|
|
"Except for numeric characters and /, all other characters in the argument are invalid.\r\n"
|
|
"The Shell will report an error if the number is in the wrong month/date/year range.\r\n"
|
|
"Space before or after the numeric character is not allowed. Inserting a space into the\r\n"
|
|
"number is invalid.\r\n"
|
|
"Repeated zeros are allowed before the number. For example:\r\n"
|
|
"Shell > date 0000008/000004/000097\r\n"
|
|
"Shell > date\r\n"
|
|
"08/04/2097\r\n"
|
|
"Shell >\r\n"
|
|
"The year range is greater than or equal to 1998. Two numeric characters indicate the year. Numbers below 98 are regarded as 20xx, and numbers equal to or above 90 are regarded as 19xx. 00 means 2000. For example:\r\n"
|
|
"Shell > date 8/4/97\r\n"
|
|
"Shell > date\r\n"
|
|
"08/04/2097\r\n"
|
|
"Shell >\r\n"
|
|
"Shell > date 8/4/98\r\n"
|
|
"Shell > date\r\n"
|
|
"08/04/1998\r\n"
|
|
"Shell >\r\n"
|
|
"The range of valid years is from 1998-2099.\r\n"
|
|
".SH RETURNVALUES\r\n"
|
|
"SHELL_SUCCESS The action was completed as requested.\r\n"
|
|
"SHELL_DEVICE_ERROR There was a hardware error preventing the completion\r\n"
|
|
" of this command\r\n"
|
|
"SHELL_SECURITY_VIOLATION This function was not performed due to a security \r\n"
|
|
" violation\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"
|
|
".SH EXAMPLES\r\n"
|
|
"To display the current date in the system:\r\n"
|
|
" fs0:\> date\r\n"
|
|
" 06/18/2001\r\n"
|
|
"To set the date with long year format:\r\n"
|
|
" fs0:\> date 01/01/2050\r\n"
|
|
" fs0:\> date\r\n"
|
|
" 01/01/2050\r\n"
|
|
"To set the date with short year format:\r\n"
|
|
" fs0:\> date 06/18/01\r\n"
|
|
" fs0:\> date\r\n"
|
|
" 06/18/2001\r\n"
|
|
|
|
#string STR_GET_HELP_TIME #language en-US ""
|
|
".TH time 0 "display or set time"\r\n"
|
|
".SH NAME\r\n"
|
|
"Displays or sets the current time for the system.\r\n"
|
|
".SH SYNOPSIS\r\n"
|
|
"time [hh:mm[:ss]] [-tz tz] [-d dl]\r\n"
|
|
".SH OPTIONS\r\n"
|
|
"hh New hour (0-23) (required)\r\n"
|
|
"mm New minute (0-59) (required)\r\n"
|
|
"ss New second (0-59) If not specified, then zero will be used.\r\n"
|
|
"-tz Timezone adjustment, measured in minutes offset from UTC. Valid values\r\n"
|
|
" can be between -1440 and 1440 or 2047. If not present or set to 2047,\r\n"
|
|
" time is interpreted as local time.\r\n"
|
|
"-d Indicates that time is not affected by daylight savings time (0), time\r\n"
|
|
" is affected by daylight savings time but time has not been adjusted \r\n"
|
|
" (1), or time is affected by daylight savings time and has been adjusted\r\n"
|
|
" (3).. All other values are invalid. If no value follows -d, then the \r\n"
|
|
" current daylight savings time will be displayed.\r\n"
|
|
".SH DESCRIPTION\r\n"
|
|
"This command displays or sets the current time for the system. If no parameters are\r\n"
|
|
"used, it shows the current time. If valid hours, minutes, and seconds are provided,\r\n"
|
|
"then the system's time will be updated.\r\n"
|
|
"Note the following rules:\r\n"
|
|
"Except for numeric characters and the : character, all other characters in the\r\n"
|
|
"argument are invalid. The Shell will report an error if the number is in the wrong\r\n"
|
|
"hour/minute/second range.\r\n"
|
|
"Spaces before or after the numeric character are not allowed. Spaces inserted into the\r\n"
|
|
"number are not allowed either.\r\n"
|
|
"Repeated zeros are allowed before the number. For example:\r\n"
|
|
"Shell > time 00000017:000004:0000\r\n"
|
|
"Shell > time\r\n"
|
|
"17:04:00 (UTC+08:00)\r\n"
|
|
"Shell >\r\n"
|
|
"The seconds parameter is optional. If there is no seconds number, it will set to zero by\r\n"
|
|
"default.\r\n"
|
|
".SH RETURNVALUES\r\n"
|
|
"SHELL_SUCCESS The action was completed as requested.\r\n"
|
|
"SHELL_DEVICE_ERROR There was a hardware error preventing the completion\r\n"
|
|
" of this command\r\n"
|
|
"SHELL_SECURITY_VIOLATION This function was not performed due to a security\r\n"
|
|
" violation\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"
|
|
".SH EXAMPLES\r\n"
|
|
"Shell > time 17:23\r\n"
|
|
"Shell > time\r\n"
|
|
"17:23:00 (UTC+08:00)\r\n"
|
|
"Shell > time 17:23:\r\n"
|
|
"Shell > time\r\n"
|
|
"17:23:00 (UTC+08:00)\r\n"
|
|
"To display current time:\r\n"
|
|
"fs0:\> time\r\n"
|
|
"16:51:03 (UTC+08:00)\r\n"
|
|
"To set the system time:\r\n"
|
|
"fs0:\> time 9:51:30\r\n"
|
|
"fs0:\> time\r\n"
|
|
"09:51:31 (UTC+08:00)\r\n"
|
|
"To get the time, including daylight savings time:\r\n"
|
|
"fs0:\> time 9:51:30\r\n"
|
|
"fs0:\> time -d\r\n"
|
|
"09:51:31 (UTC+08:00) DST: Not Affected\r\n"
|
|
|
|
#string STR_GET_HELP_TIMEZONE #language en-US ""
|
|
".TH timezone 0 "display or change timezone"\r\n"
|
|
".SH NAME\r\n"
|
|
"Displays or sets time zone information.\r\n"
|
|
".SH SYNOPSIS\r\n"
|
|
"timezone [-s hh:mm | -l] [-b] [-f]\r\n"
|
|
".SH OPTIONS\r\n"
|
|
"-s Set time zone associated with hh:mm offset from UTC\r\n"
|
|
"-l Display list of all time zones\r\n"
|
|
"-b Display one screen at a time\r\n"
|
|
"-f Display full information for specified timezone\r\n"
|
|
".SH DESCRIPTION\r\n"
|
|
"This command displays and sets the current time zone for the system. If no parameters are used, it shows the current time zone. If a valid hh:mm parameter is provided, then the system's time zone information will be updated.\r\n"
|
|
".SH RETURNVALUES\r\n"
|
|
"no defined return values\r\n"
|
|
".SH EXAMPLES\r\n"
|
|
"To display all available time zones:\r\n"
|
|
" %EShell>%N timezone -l\r\n"
|
|
" UTC-12:00, International Date Line West\r\n"
|
|
" UTC-11:00, Midway Island, Samoa\r\n"
|
|
" UTC-10:00, Hawaii\r\n"
|
|
" UTC-09:00, Alaska\r\n"
|
|
" UTC-08:00, Pacific Time(US & Canada); Tijuana\r\n"
|
|
" UTC-07:00, Arizona, Chihuahua, La Paz, Mazatlan\r\n"
|
|
" UTC-06:00, Central America, Central Time(US & Canada)\r\n"
|
|
" UTC-05:00, Bogota, Lima, Quito, Eastern Time(US & Canada)\r\n"
|
|
" UTC-04:00, Atlantic Time(Canada), Caracas, Santiago\r\n"
|
|
" UTC-03:30, Newfoundland\r\n"
|
|
" UTC-03:00, Brasilia, Buenos Aires, Georgetown, Greenland\r\n"
|
|
" UTC-02:00, Mid-Atlantic\r\n"
|
|
" UTC-01:00, Azores, Cape Verde Is.\r\n"
|
|
" UTC, Greenwich Mean Time, Casablanca, Monrovia, Dublin, London\r\n"
|
|
" UTC+01:00, Amsterdam, Berlin, Bern, Rome, Paris, West Central Africa\r\n"
|
|
" UTC+02:00, Athens, Istanbul, Bucharest, Cairo, Jerusalem\r\n"
|
|
" UTC+03:00, Baghdad, Kuwait, Riyadh, Moscow, Nairobi\r\n"
|
|
" UTC+03:30, Tehran\r\n"
|
|
" UTC+04:00, Abu Dhabi, Muscat, Baku, Tbilisi, Yerevan\r\n"
|
|
" UTC+04:30, Kabul\r\n"
|
|
" UTC+05:00, Ekaterinburg, Islamabad, Karachi, Tashkent\r\n"
|
|
" UTC+05:30, Chennai, Kolkata, Mumbai, New Delhi\r\n"
|
|
" UTC+05:45, Kathmandu\r\n"
|
|
" UTC+06:00, Almaty, Novosibirsk, Astana, Dhaka, Sri Jayawardenepura\r\n"
|
|
" UTC+06:30, Rangoon\r\n"
|
|
" UTC+07:00, Bangkok, Hanio, Jakarta, Krasnoyarsk\r\n"
|
|
" UTC+08:00, Beijing, Chongqing, Hong Kong, Urumqi, Taipei, Perth\r\n"
|
|
" UTC+09:00, Osaka, Sapporo, Tokyo, Seoul, Yakutsk\r\n"
|
|
" UTC+09:30, Adelaide, Darwin\r\n"
|
|
" UTC+10:00, Canberra, Melbourne, Sydney, Guam, Hobart, Vladivostok\r\n"
|
|
" UTC+11:00, Magadan, Solomon Is., New Caledonia\r\n"
|
|
" UTC+12:00, Auckland, Wellington, Fiji, Kamchatka, Marshall Is.\r\n"
|
|
" UTC+13:00, Nuku'alofa\r\n"
|
|
"To set the time zone:\r\n"
|
|
" %EShell>%N timezone -s -7:00\r\n"
|
|
" %EShell>%N timezone\r\n"
|
|
" UTC-07:00\r\n"
|
|
" %EShell>%N timezone -s 5:00\r\n"
|
|
" %EShell>%N timezone\r\n"
|
|
" UTC+05:00\r\n"
|
|
"To display detailed information for the current time zone:\r\n"
|
|
" %EShell>%N timezone -f\r\n"
|
|
" UTC+05:00, Ekaterinburg, Islamabad, Karachi, Tashkent\r\n"
|
|
" %EShell>%N timezone\r\n"
|
|
" UTC+05:00\r\n"
|
|
|
|
#string STR_GET_HELP_LS #language en-US ""
|
|
".TH ls 0 "lists files and directories"\r\n"
|
|
".SH NAME\r\n"
|
|
"Lists a directory's contents or file information.\r\n"
|
|
".SH SYNOPSIS\r\n"
|
|
"ls [-r] [-a[attrib]][-sfo][file]\r\n"
|
|
".SH OPTIONS\r\n"
|
|
"-r Displays recursively (including subdirectories)\r\n"
|
|
"-a Display only those files with the attributes which follow. If no \r\n"
|
|
" attributes are listed, then all files will be listed. If -a is not\r\n"
|
|
" specified, then all non-system and non-hidden files will be listed.\r\n"
|
|
" The attributes (attrib) may be one or more of the following:\r\n"
|
|
" 1. a - Archive\r\n"
|
|
" 2. s - System\r\n"
|
|
" 3. h - Hidden\r\n"
|
|
" 4. r - Read-only\r\n"
|
|
" 5. d - Directory\r\n"
|
|
"-sfo Display information as described in "Standard-Format Output" below.\r\n"
|
|
"file Name of file/directory (wildcards are permitted)\r\n"
|
|
".SH DESCRIPTION\r\n"
|
|
"This command lists directory contents or file information. If no file name or directory name is specified, then the current working directory is assumed. The contents of a directory are listed if all of the following are true:\r\n"
|
|
" If option -r is not specified\r\n"
|
|
" If no wildcard characters are specified in the file parameter\r\n"
|
|
" If file represents an existing directory\r\n"
|
|
"In all other cases, the command functions as follows:\r\n"
|
|
" All files/directories that match the specified name are displayed.\r\n"
|
|
" The -r flag determines whether a recursive search is performed.\r\n"
|
|
" The option flag -a[attrib] tells the command to display only those files with the attributes that are specified by [attrib]. If more than one attribute is specified, only the files that have all those attributes will be listed. If -a is followed by nothing, then all files/directories are displayed, regardless of their attributes. If -a itself is not specified, then all files except system and hidden files are displayed.\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 or directory was not found.\r\n"
|
|
".SH EXAMPLES\r\n"
|
|
"To hide files by adding the hidden or system attribute to them:\r\n"
|
|
"fs0:\> attrib +s +h *.efi\r\n"
|
|
"ASH fs0:\IsaBus.efi\r\n"
|
|
"ASH fs0:\IsaSerial.efi\r\n"
|
|
"To display all, except the files/directories with 'h' or 's' attribute:\r\n"
|
|
"fs0:\> ls\r\n"
|
|
"Directory of: fs0:\\r\n"
|
|
"06/18/01 09:32p 153 for.nsh\r\n"
|
|
"06/18/01 01:02p <DIR> 512 efi\r\n"
|
|
"06/18/01 01:02p <DIR> 512 test1\r\n"
|
|
"06/18/01 01:02p <DIR> 512 test2\r\n"
|
|
"06/18/01 08:04p 29 temp.txt\r\n"
|
|
"06/18/01 08:05p <DIR> 512 test\r\n"
|
|
"01/28/01 08:24p r 29 readme.txt\r\n"
|
|
"3 File(s) 211 bytes\r\n"
|
|
"4 Dir(s)\r\n"
|
|
"To display files with all attributes in the current directory:\r\n"
|
|
"fs0:\> ls -a\r\n"
|
|
"Directory of: fs0:\\r\n"
|
|
"06/18/01 09:32p 153 for.nsh\r\n"
|
|
"06/18/01 01:02p <DIR> 512 efi\r\n"
|
|
"06/18/01 01:02p <DIR> 512 test1\r\n"
|
|
"06/18/01 01:02p <DIR> 512 test2\r\n"
|
|
"06/18/01 10:59p 28,739 IsaBus.efi\r\n"
|
|
"06/18/01 10:59p 32,838 IsaSerial.efi\r\n"
|
|
"06/18/01 08:04p 29 temp.txt\r\n"
|
|
"06/18/01 08:05p <DIR> 512 test\r\n"
|
|
"01/28/01 08:24p r 29 readme.txt\r\n"
|
|
"5 File(s) 61,788 bytes\r\n"
|
|
"4 Dir(s)\r\n"
|
|
"To display files with read-only attributes in the current directory:\r\n"
|
|
"fs0:\> ls -ar\r\n"
|
|
"Directory of: fs0:\\r\n"
|
|
"06/18/01 11:14p r 29 readme.txt\r\n"
|
|
"1 File(s) 29 bytes\r\n"
|
|
"0 Dir(s)\r\n"
|
|
"To display the files with attribute of 's':\r\n"
|
|
"fs0:\> ls -as isabus.efi\r\n"
|
|
"Directory of: fs0:\\r\n"
|
|
"06/18/01 10:59p 28,739 IsaBus.efi\r\n"
|
|
"1 File(s) 28,739 bytes\r\n"
|
|
"0 Dir(s)\r\n"
|
|
"To display all in fs0:\efi directory recursively:\r\n"
|
|
"fs0:\> ls -r -a efi\r\n"
|
|
"To search for files with the specified type in the current directory recursively:\r\n"
|
|
"fs0:\> ls -r -a *.efi -b\r\n"
|
|
|
|
#string STR_GET_HELP_LOAD #language en-US ""
|
|
".TH load 0 "Loads file into memory"\r\n"
|
|
".SH NAME\r\n"
|
|
"Loads a UEFI driver into memory.\r\n"
|
|
".SH SYNOPSIS\r\n"
|
|
"load [-nc] file [file...]\r\n"
|
|
".SH OPTIONS\r\n"
|
|
"-nc Load the driver, but do not connect the driver.\r\n"
|
|
"File File that contains the image of the UEFI driver (wildcards are permitted)\r\n"
|
|
".SH DESCRIPTION\r\n"
|
|
"This command loads an driver into memory. It can load multiple files at one time, and the file name supports wildcards.\r\n"
|
|
"If the -nc flag is not specified, this command will try to connect the driver to a proper device; it may also cause already loaded drivers be connected to their corresponding devices.\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 formatted or its value was out of bounds.\r\n"
|
|
"SHELL_SECURITY_VIOLATION This function was not performed due to a security violation.\r\n"
|
|
"SHELL_NOT_FOUND The requested file was not found.\r\n"
|
|
".SH EXAMPLES\r\n"
|
|
"fs0:\> load Isabus.efi\r\n"
|
|
"load: Image 'fs0:\Isabus.efi' loaded at 18FE000 - Success\r\n"
|
|
"fs0:\> load Isabus.efi IsaSerial.efi\r\n"
|
|
"load: Image 'fs0:\Isabus.efi' loaded at 18E5000 - Success\r\n"
|
|
"load: Image 'fs0:\IsaSerial.efi' loaded at 18DC000 - Success\r\n"
|
|
"fs0:\> load Isa*.efi\r\n"
|
|
"load: Image 'fs0:\IsaBus.efi' loaded at 18D4000 - Success\r\n"
|
|
"load: Image 'fs0:\IsaSerial.efi' loaded at 18CB000 - Success\r\n"
|
|
"fs0:\> load -nc IsaBus.efi\r\n"
|
|
"load: Image 'fs0:\Isabus.efi' loaded at 18FE000 - Success\r\n"
|
|
|
|
#string STR_GET_HELP_VOL #language en-US ""
|
|
".TH vol 0 "display volume info"\r\n"
|
|
".SH NAME\r\n"
|
|
"Displays or changes a file system volume label.\r\n"
|
|
".SH SYNOPSIS\r\n"
|
|
"vol [fs] [-n <VolumeLabel>]\r\n"
|
|
"vol [fs] [-d]\r\n"
|
|
".SH OPTIONS\r\n"
|
|
"fs The name of the file system.\r\n"
|
|
"VolumeLabel The name of the file system. The following characters cannot be used: % ^ * + = [ ] | : ; \" < > ? / . No spaces are allowed in the volume label.\r\n"
|
|
"-d Empty volume label.\r\n"
|
|
".SH DESCRIPTION\r\n"
|
|
"This command displays the volume information for the file system that is specified by fs. If fs is not specified, the current file system will be used. If -n is specified, then the volume label for fs will be set to VolumeLabel. The maximum length for VolumeLabel is 11 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 formatted or its value was out of bounds.\r\n"
|
|
"SHELL_SECURITY_VIOLATION This function was not performed due to a security violation\r\n"
|
|
"SHELL_NOT_FOUND The target file-system was not found\r\n"
|
|
".SH EXAMPLES\r\n"
|
|
"To display the volume of the current fs:\r\n"
|
|
"fs0:\> vol\r\n"
|
|
"Volume has no label (rw)\r\n"
|
|
"1,457,664 bytes total disk space\r\n"
|
|
"1,149,440 bytes available on disk\r\n"
|
|
"512 bytes in each allocation unit\r\n"
|
|
"\r\n"
|
|
"To change the label of fs0:\r\n"
|
|
"shell> vol fs0 -n help_test\r\n"
|
|
"Volume HELP_TEST (rw)\r\n"
|
|
"1,457,664 bytes total disk space\r\n"
|
|
"1,149,440 bytes available on disk\r\n"
|
|
"512 bytes in each allocation unit\r\n"
|
|
"\r\n"
|
|
"To get rid of the label of fs0:\r\n"
|
|
"fs0:\> vol fs0 -d\r\n"
|
|
"Volume has no label (rw)\r\n"
|
|
"1,457,664 bytes total disk space\r\n"
|
|
"220,160 bytes available on disk\r\n"
|
|
"512 bytes in each allocation unit\r\n"
|