SHEL23
[efi/shell/.git] / ReadMe.txt
1
2 Last modified 06/21/2005
3
4 EFI Shell Source Code Release Package
5
6 This package is the source code of the EFI Shell. The EFI Shell is a special EFI 
7 application that allows batch scripting, EFI Shell commands, and other EFI Shell 
8 applications to be launched.
9
10 The EFI Shell is a simple, interactive environment that allows users to do the following:
11   * Load EFI device drivers.
12   * Launch EFI applications.
13   * Boot operating systems.
14   * Use a set of basic commands to manage files, system environment variables, and other
15 elements of EFI.
16
17 The EFI Shell provides an environment that can be modified to easily adapt to many different
18 hardware configurations.
19
20 The EFI Shell supports the following:
21   * A command line interface
22   * A set of Shell internal commands and external commands
23   * Batch scripting
24
25 For more information about the EFI Shell, user can refer the following documents:
26   * EFI Shell User's Guide
27   * EFI Shell Developer's Guide
28   * EFI Shell Release Notes
29   * EFI Shell Getting Started Guide
30   
31 ================================================================================
32 Recommended Usage
33
34 To use this EFI Shell release package, user should have installed the EFI Developer 
35 Kit (EDK), can build the NT32 tip, IPF tip and run the Nt32 emulation on the EDK.
36
37 To build the EFI Shell with this package, user should do the following things:
38 1.  Copy this package the the EDK.
39       Suppose the EDK is located at C:\EDK, this package is located at C:\Shell.
40       Type the copy command:
41       C:\> XCOPY C:\Shell C:\EDK\Other\Maintained\Application
42       Make sure that the Shell.inf file is 
43         C:\EDK\Other\Maintained\Application\Shell\Shell.inf. 
44         
45 2.  To build an IA 32 version of EFI Shell:  
46       Open the description file C:\EDK\Sample\Platform\Nt32\Build\Nt32.dsc
47         Replace component 
48         "Other\Maintained\Application\Shell\Bin\Shell.inf" with 
49         "Other\Maintained\Application\Shell\Shell.inf", like this:
50         [Components]
51         ¡­¡­
52         #Other\Maintained\Application\Shell\Bin\Shell.inf
53         Other\Maintained\Application\Shell\Shell.inf
54         ¡­¡­
55
56         Type the command:
57         Cd C:\EDK\Sample\Platform\Nt32\Build
58         Set the environment variable:
59         C:\EDK\Sample\Platform\Nt32\Build>Set EDK_SOURCE=C:\EDK
60         Build:
61         C:\EDK\Sample\Platform\Nt32\Build>nmake
62         Run the Nt32 emulation:
63         C:\EDK\Sample\Platform\Nt32\Build>nmake run
64
65 3.  To build an Itanium(R) architecture version of EFI Shell:
66       Open the description file C:\EDK\Sample\Platform\IPF\Build\IPF.dsc
67         Replace component 
68         "Other\Maintained\Application\Shell\Bin\Shell.inf" 
69         with "Other\Maintained\Application\Shell\Shell.inf", like this:
70         [Components]
71         ¡­¡­
72         #Other\Maintained\Application\Shell\Bin\Shell.inf
73         Other\Maintained\Application\Shell\Shell.inf
74         ¡­¡­
75
76         Type the command:
77         Cd C:\EDK\Sample\Platform\IPF\Build
78         Set the environment variable:
79         C:\EDK\Sample\Platform\IPF\Build>Set EDK_SOURCE=C:\EDK
80         Build:
81         C:\EDK\Sample\Platform\IPF\Build>nmake
82 ================================================================================
83