ShellPkg: Enhance 'cls' command to change the background and foreground colors

[mirror_edk2.git] / ShellPkg / Library / UefiShellLevel3CommandsLib / UefiShellLevel3CommandsLib.uni

diff --git a/ShellPkg/Library/UefiShellLevel3CommandsLib/UefiShellLevel3CommandsLib.uni b/ShellPkg/Library/UefiShellLevel3CommandsLib/UefiShellLevel3CommandsLib.uni
index fc9c5d447ccc3a13fd69862f9e2eed847c9cfa0d..bbcb752ac06e58afea3fe71539225195769c880f 100644 (file)
--- a/ShellPkg/Library/UefiShellLevel3CommandsLib/UefiShellLevel3CommandsLib.uni
+++ b/ShellPkg/Library/UefiShellLevel3CommandsLib/UefiShellLevel3CommandsLib.uni
@@ -1,5 +1,6 @@
 // /**\r
 //\r
+// (C) Copyright 2016 Hewlett Packard Enterprise Development LP<BR>\r
 // (C) Copyright 2013-2015 Hewlett-Packard Development Company, L.P.<BR>\r
 // Copyright (c) 2009 - 2013, Intel Corporation. All rights reserved. <BR>\r
 // This program and the accompanying materials\r
@@ -82,6 +83,7 @@
 #string STR_ALIAS_OUTPUT          #language en-US "%1c %10s:%s\r\n"\r
 \r
 #string STR_GET_MTC_OUTPUT        #language en-US "%016Lx\r\n"\r
+#string STR_CLS_OUTPUT_SFO        #language en-US "ConOutAttribInfo,"%d","%d","%d"\r\n"\r
 \r
 #string STR_GET_HELP_HELP         #language en-US ""\r
 ".TH help 0 "Displays help information from the UEFI Shell."\r\n"\r
@@ -201,38 +203,62 @@
 #string STR_GET_HELP_CLS          #language en-US ""\r
 ".TH cls 0 "clear screen"\r\n"\r
 ".SH NAME\r\n"\r
-"Clears standard output and optionally changes background color.\r\n"\r
+"Clears the console output and optionally changes the background and foreground color.\r\n"\r
 ".SH SYNOPSIS\r\n"\r
 " \r\n"\r
-"CLS [color]\r\n"\r
+"CLS [background] [foreground] | [-sfo]\r\n"\r
 ".SH OPTIONS\r\n"\r
 " \r\n"\r
-"  color - Sets a new background color:\r\n"\r
-"            0 - Black\r\n"\r
-"            1 - Blue\r\n"\r
-"            2 - Green\r\n"\r
-"            3 - Cyan\r\n"\r
-"            4 - Red\r\n"\r
-"            5 - Magenta\r\n"\r
-"            6 - Yellow\r\n"\r
-"            7 - Light gray\r\n"\r
+"  background - Sets a new background color:\r\n"\r
+"               0 - Black\r\n"\r
+"               1 - Blue\r\n"\r
+"               2 - Green\r\n"\r
+"               3 - Cyan\r\n"\r
+"               4 - Red\r\n"\r
+"               5 - Magenta\r\n"\r
+"               6 - Yellow\r\n"\r
+"               7 - Light gray\r\n"\r
+"  foreground - Sets a new foreground color:\r\n"\r
+"               0  - Black\r\n"\r
+"               1  - Blue\r\n"\r
+"               2  - Green\r\n"\r
+"               3  - Cyan\r\n"\r
+"               4  - Red\r\n"\r
+"               5  - Magenta\r\n"\r
+"               6  - Yellow\r\n"\r
+"               7  - Light gray\r\n"\r
+"               8  - Dark gray\r\n"\r
+"               9  - Light blue\r\n"\r
+"               10 - Light green\r\n"\r
+"               11 - Light cyan\r\n"\r
+"               12 - Light red\r\n"\r
+"               13 - Light magenta\r\n"\r
+"               14 - Yellow\r\n"\r
+"               15 - White\r\n"\r
+"  -sfo       - Displays current console color settings in Standard Format\r\n"\r
+"               Output.\r\n"\r
 ".SH DESCRIPTION\r\n"\r
 " \r\n"\r
 "NOTES:\r\n"\r
 "  1. This command clears the standard output device with an optional\r\n"\r
-"     background color attribute. If a color is not specified, then the\r\n"\r
-"     background color does not change.\r\n"\r
+"     background and foreground color attribute.\r\n"\r
+"  2. If background color is not specified, or if background and foreground\r\n"\r
+"     colors are not specified, then the colors do not change.\r\n"\r
+"  3. When -sfo flag is used, console output is not cleared and instead it\r\n"\r
+"     displays current console foreground and background attribute settings.\r\n"\r
 ".SH EXAMPLES\r\n"\r
 " \r\n"\r
 "EXAMPLES:\r\n"\r
-"  * To clear standard output without changing the background color:\r\n"\r
+"  * To clear standard output without changing the background or foreground\r\n"\r
+"    color:\r\n"\r
 "    fs0:\> cls\r\n"\r
 " \r\n"\r
 "  * To clear standard output and change the background color to cyan:\r\n"\r
 "    fs0:\> cls 3\r\n"\r
 " \r\n"\r
-"  * To clear standard output and change the background to the default color:\r\n"\r
-"    fs0:\> cls 0\r\n"\r
+"  * To clear standard output and change the background to black and foreground\r\n"\r
+"    to white:\r\n"\r
+"    fs0:\> cls 0 15\r\n"\r
 ".SH RETURNVALUES\r\n"\r
 " \r\n"\r
 "RETURN VALUES:\r\n"\r