Skip to content
Richard Nusser edited this page Jan 8, 2018 · 2 revisions

The descriptions of included applications are currently being added slowly.

General

Executable applications have the (case insensitive) ".efi" file extension. Not all .efi files are applications though, the shell will tell you if you're trying to run e.g. a driver.

You can run the applications in the UEFI shell - with or without the .efi extension. Note that if a command built into the UEFI shell (e.g. memmap) and an application (e.g. memmap.efi) share the same name you need to include the ".efi" extension if you intend to call the application:

  • memmap: built-in command gets executed
  • memmap.efi: custom application gets called

(there currently are no applications included that share names with shell built-ins)

Common Features

All applications support command-line parameters. The -help argument is always available, it shows the application's help screen and quits, for example:

FS0:\> helloworld -help
Greetings, non-spherical habitation rock!
General options:
  -help    This text

Logging options:
  -trace   Set log threshold to TRACE
  -debug   Set log threshold to DEBUG
  -info    Set log threshold to INFO
  -warn    Set log threshold to WARN
  -error   Set log threshold to ERROR
  -no-log  Disable logging

Group 1:
  -bool            boolean parameter
  -dbl <decimal>   double parameter [default: 0.66]

Group 2:
  -int <integer>  integer parameter [default: 2]

The application and library code emits log entries at various levels, the log verbosity can be set with any of the "Logging options" listed above.

Applications may support custom command-line arguments of any of 4 types: boolean, integer, decimal or string. All but the boolean type require a value after the argument name, for example (output trimmed):

FS0:\> helloworld -bool -dbl 67.89
effective argument values after defaults:
  -bool: 1
  -dbl:  67.89
  -int:  2
Clone this wiki locally