Comment's added and fixed.
[mirror_edk2.git] / ShellPkg / ShellPkg.dec
1 ## @file ShellPkg.dec\r
2 #\r
3 # This Package provides all definitions for EFI and UEFI Shell\r
4 #\r
5 # Copyright (c) 2009, Intel Corporation. All rights reserved.<BR>\r
6 #\r
7 # This program and the accompanying materials are licensed and made available under\r
8 # the terms and conditions of the BSD License which accompanies this distribution.\r
9 # The full text of the license may be found at\r
10 # http://opensource.org/licenses/bsd-license.php\r
11 #\r
12 # THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
13 # WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
14 #\r
15 ##\r
16 \r
17 \r
18 [Defines]\r
19   DEC_SPECIFICATION              = 0x00010005\r
20   PACKAGE_NAME                   = ShellPkg\r
21   PACKAGE_GUID                   = 9FB7587C-93F7-40a7-9C04-FD7BA94EE646\r
22   PACKAGE_VERSION                = 0.40\r
23 \r
24 \r
25 [Includes.common]\r
26   Include\r
27 \r
28 [LibraryClasses.common]\r
29   ##  @libraryclass  Provides most Shell APIs. Only available for Shell applications\r
30   ShellLib|Include/Library/ShellLib.h\r
31 \r
32   ##  @libraryclass  Provides shell internal support Only available for shell internal commands\r
33   ShellCommandLib|Include/Library/ShellCommandLib.h\r
34 \r
35   ##  @libraryclass  provides EFI_FILE_HANDLE services used by Shell and ShellLib\r
36   FileHandleLib|Include/Library/FileHandleLib.h\r
37 \r
38   ## @libraryclass   Allows for a shell application to have a C style entry point\r
39   ShellCEntryLib|Include/Library/ShellCEntryLib.h\r
40 \r
41   ## @libraryclass   Provides sorting functions\r
42   SortLib|Include/Library/SortLib.h\r
43 \r
44   ## @libraryclass   Provides advanced parsing functions\r
45   HandleParsingLib|Include/Library/HandleParsingLib.h\r
46 \r
47 [Guids.common]\r
48   gEfiShellEnvironment2ExtGuid    = {0xd2c18636, 0x40e5, 0x4eb5, {0xa3, 0x1b, 0x36, 0x69, 0x5f, 0xd4, 0x2c, 0x87}}\r
49   gEfiShellPkgTokenSpaceGuid        = {0x171e9188, 0x31d3, 0x40f5, {0xb1, 0x0c, 0x53, 0x9b, 0x2d, 0xb9, 0x40, 0xcd}}\r
50   gShellVariableGuid              = {0x158def5a, 0xf656, 0x419c, {0xb0, 0x27, 0x7a, 0x31, 0x92, 0xc0, 0x79, 0xd2}}\r
51   gShellMapGuid                   = {0x51271e13, 0x7de3, 0x43af, {0x8b, 0xc2, 0x71, 0xad, 0x3b, 0x82, 0x43, 0x25}}\r
52   gShellAliasGuid                 = {0x0053d9d6, 0x2659, 0x4599, {0xa2, 0x6b, 0xef, 0x45, 0x36, 0xe6, 0x31, 0xa9}}\r
53 \r
54 \r
55 [Protocols.common]\r
56   gEfiShellProtocolGuid           = {0x6302d008, 0x7f9b, 0x4f30, {0x87, 0xac, 0x60, 0xc9, 0xfe, 0xf5, 0xda, 0x4e}}\r
57   gEfiShellParametersProtocolGuid = {0x752f3136, 0x4e16, 0x4fdc, {0xa2, 0x2a, 0xe5, 0xf4, 0x68, 0x12, 0xf4, 0xca}}\r
58   gEfiShellEnvironment2Guid       = {0x47c7b221, 0xc42a, 0x11d2, {0x8e, 0x57, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b}}\r
59   gEfiShellInterfaceGuid          = {0x47c7b223, 0xc42a, 0x11d2, {0x8e, 0x57, 0x00, 0xa0, 0xc9, 0x69, 0x72, 0x3b}}\r
60 \r
61 [PcdsFixedAtBuild]\r
62   ## This flag is used to control initialization of the shell library\r
63   #  This should be FALSE for compiling the shell application itself only.\r
64   gEfiShellPkgTokenSpaceGuid.PcdShellLibAutoInitialize|TRUE|BOOLEAN|0x00000005\r
65 \r
66   ## This is the max buffer for ShellLib, FileHandleLib, and internal Shell printings.\r
67   gEfiShellPkgTokenSpaceGuid.PcdShellPrintBufferSize|16000|UINT16|0x0000000C\r
68 \r
69   ## This flag is used to control the commands available in the shell\r
70   gEfiShellPkgTokenSpaceGuid.PcdShellSupportLevel|3|UINT8|0x00000001\r
71 \r
72   ## This flag is used to control the profiles available in the shell\r
73   #  don't forget to update the text file if you change this.\r
74   #  bit 0 = Drivers1\r
75   #  bit 1 = Debug1\r
76   #  bit 2 = Install1\r
77   #  bit 3 = Network1\r
78   gEfiShellPkgTokenSpaceGuid.PcdShellProfileMask|0xFF|UINT8|0x0000000D\r
79 \r
80   ## This is the character count for allocation for consistent mappings\r
81   gEfiShellPkgTokenSpaceGuid.PcdShellMapNameLength|50|UINT8|0x00000009\r
82 \r
83   ## This determins how many bytes are read out of files at a time for file operations (type, copy, etc...)\r
84   gEfiShellPkgTokenSpaceGuid.PcdShellFileOperationSize|1000|UINT16|0x0000000A\r
85 \r
86 [PcdsFeatureFlag]\r
87   ## This flag is used to control whether the shell includes NT32 platform Guids\r
88   #  and thereby prevents dependancy on that Pkg\r
89   gEfiShellPkgTokenSpaceGuid.PcdShellIncludeNtGuids|TRUE|BOOLEAN|0x0000000E\r
90 \r
91   ## This flag is used to control HII required by the shell\r
92   gEfiShellPkgTokenSpaceGuid.PcdShellRequireHiiPlatform|TRUE|BOOLEAN|0x00000003\r
93 \r
94   ## This flag is used to control HII required by the shell\r
95   gEfiShellPkgTokenSpaceGuid.PcdShellSupportFrameworkHii|FALSE|BOOLEAN|0x00000004\r
96   \r
97   ## This flag forces the shell to present a user console.  Allows for earlier debugging of platforms.\r
98   gEfiShellPkgTokenSpaceGuid.PcdShellForceConsole|FALSE|BOOLEAN|0x0000000F\r
99 \r
100 [PcdsFixedAtBuild,PcdsPatchableInModule,PcdsDynamic]\r
101   ## This flag is used to control the protocols produced by the shell\r
102   #  If TRUE the shell will produce EFI_SHELL_ENVIRONMENT2 and EFI_SHELL_INTERFACE\r
103   gEfiShellPkgTokenSpaceGuid.PcdShellSupportOldProtocols|FALSE|BOOLEAN|0x00000002\r
104 \r
105   ## this flag determins whether Page Break (-b) defaults to on or off in the shell\r
106   gEfiShellPkgTokenSpaceGuid.PcdShellPageBreakDefault|FALSE|BOOLEAN|0x00000006\r
107 \r
108   ## this flag determins whether insert mode for typing is default (FALSE means typeover)\r
109   gEfiShellPkgTokenSpaceGuid.PcdShellInsertModeDefault|TRUE|BOOLEAN|0x00000007\r
110 \r
111   ## this flag determins the default number of screens kept for history log.\r
112   #  the spec defines 3 as the minimum\r
113   gEfiShellPkgTokenSpaceGuid.PcdShellScreenLogCount|3|UINT8|0x00000008