git.gag.com Git - debian/elilo/blob - docs/eliloalt.txt

   1 Information related to the eliloalt Linux tool
   2 ---------------------------------------------
   3 (c) 2002-2003 Hewlett Packard Co
   4     Contributed by Stephane Eranian <eranian@hpl.hp.com>
   5
   6     Last updated: March 1st, 2002
   7
   8
   9 The elilo alternate image feature uses an EFI variable called EliloAlt.
  10 The content of this variable is a UNICODE string containing a kernel
  11 image file and its command line options. The variable has a NULL GUID.
  12
  13 To create, read, or modify the variable you need to use the EFI variable
  14 service and the SetVariable() or GetVariable() interface. The service
  15 is available when EFI is in boot service mode, i.e., prior to loading
  16 the kernel but it is also available at runtime when the Linux kernel
  17 has taken over the control of the machine.
  18
  19 In order to modify the variable, you can either write a small EFI applications
  20 or use the Linux/ia64 interface to the EFI variables which use the /proc filesystem.
  21
  22 The elilalt tool included in this package uses the /proc interface to EFI variables
  23 to create, read, or modify the EliloAlt variable. This tool is a Linux/ia64 application
  24 and NOT an EFI application.
  25
  26
  27 Because modiyfing the EliloAlt can influence how the machine is booted, you must
  28 be root to run the program, even when you simply want to read the content of
  29 the variable.
  30
  31 Eliloalt provides the following options:
  32
  33         -h, --help              display this help and exit
  34         --version               output version information and exit
  35         -s, --set cmdline       set elilo alternate variable to cmdline
  36         -p, --print             print elilo alternate variable
  37         -d, --delete            print elilo alternate variable
  38
  39 1/ Creation of the variable
  40
  41         To create the variable you can type:
  42
  43         # eliloalt -s "vmlinuz-2.4.9 root=/dev/sdb2 hdc=ide-scsi"
  44
  45         It is VERY important to use quotes to make sure that the entire list of arguments is
  46         treated as a single argument to the program. Otherwise only the first element
  47         (here vmlinuz-2.4.9) will be used.
  48
  49
  50 2/ Printing the content of the variable
  51
  52         To print the content of the variable you need to type:
  53
  54         # eliloalt -p
  55         EliloAlt="vmlinuz-2.4.9 root=/dev/sdb2 hdc=ide-scsi"
  56
  57 3/ Modifying the variable
  58
  59         You can simply use the -s option:
  60         # eliloalt -s "vmlinuz-2.4.18 root=/dev/sdb2"
  61         # eliloalt -p
  62         EliloAlt="vmlinuz-2.4.18 root=/dev/sdb2"
  63
  64 3/ Deleting the variable
  65
  66         You must use the -d option:
  67         # eliloalt -p
  68         EliloAlt="vmlinuz-2.4.18 root=/dev/sdb2"
  69         # eliloalt -d
  70         # eliloalt -p
  71         variable not defined
  72
  73         Keep in mind that the variable is automatically deleted by elilo if:
  74                 - the checkalt option is specified in the config file
  75             OR
  76                 - the -a is used on the command line
  77