Home | History | Annotate | Download | only in UefiShellBcfgCommandLib
      1 // /**
      2 //
      3 // (C) Copyright 2014-2015 Hewlett-Packard Development Company, L.P.<BR>
      4 // Copyright (c) 2010 - 2014, Intel Corporation. All rights reserved.<BR>
      5 // This program and the accompanying materials
      6 // are licensed and made available under the terms and conditions of the BSD License
      7 // which accompanies this distribution. The full text of the license may be found at
      8 // http://opensource.org/licenses/bsd-license.php
      9 //
     10 // THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
     11 // WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
     12 //
     13 // Module Name:
     14 //
     15 // UefiBcfgCommandsLib.uni
     16 //
     17 // Abstract:
     18 //
     19 // String definitions for UEFI Shell 2.0 BCFG command
     20 //
     21 //
     22 // **/
     23 
     24 /=#
     25 
     26 #langdef   en-US "english"
     27 
     28 #string STR_GEN_NO_MEM            #language en-US "%H%s%N: Memory is not available.\r\n"
     29 #string STR_GEN_PROBLEM           #language en-US "%H%s%N: Unknown flag - '%H%s%N'\r\n"
     30 #string STR_GEN_PROBLEM_VAL       #language en-US "%H%s%N: Bad value - '%H%s%N' for flag - '%H%s%N'\r\n"
     31 #string STR_GEN_NO_VALUE          #language en-US "%H%s%N: Missing argument for flag - '%H%s%N'\r\n"
     32 #string STR_GEN_PARAM_INV         #language en-US "%H%s%N: Invalid argument - '%H%s%N'\r\n"
     33 #string STR_GEN_NO_DRIVER_BOOT    #language en-US "%H%s%N: Driver or Boot must be selected.\r\n"
     34 #string STR_GEN_BOOT_ONLY         #language en-US "%H%s%N: Boot must be selected for hot key options.\r\n"
     35 #string STR_GEN_TOO_FEW           #language en-US "%H%s%N: Too few arguments.\r\n"
     36 #string STR_GEN_TOO_MANY          #language en-US "%H%s%N: Too many arguments.\r\n"
     37 #string STR_GEN_FILE_OPEN_FAIL    #language en-US "%H%s%N: Cannot open file - '%H%s%N'\r\n"
     38 #string STR_GEN_FIND_FAIL         #language en-US "%H%s%N: File not found - '%H%s%N'\r\n"
     39 #string STR_GEN_OUT_MEM           #language en-US "%H%s%N: Memory allocation was not successful.\r\n"
     40 #string STR_BCFG_WRITE_FAIL       #language en-US "%H%s%N: Unable to write to '%H%s%N'\r\n"
     41 #string STR_BCFG_READ_FAIL        #language en-US "%H%s%N: Unable to read from '%H%s%N'\r\n"
     42 #string STR_BCFG_HANDLE           #language en-US "%H%s%N: The handle [%H%02x%N] does not have DevicePath.\r\n"
     43 #string STR_BCFG_FILE             #language en-US "%H%s%N: The file '%H%s%N' matches multiple files.\r\n"
     44 #string STR_BCFG_FILE_OPEN        #language en-US "%H%s%N: The file '%H%s%N' did not open.\r\n"
     45 #string STR_BCFG_FILE_DP          #language en-US "%H%s%N: The file '%H%s%N' could not convert to DevPath.\r\n"
     46 #string STR_BCFG_TARGET_NF        #language en-US "%H%s%N: Could not find unused target index.\r\n"
     47 #string STR_BCFG_TARGET           #language en-US "Target = %04x.\r\n"
     48 #string STR_BCFG_SET_VAR_FAIL     #language en-US "%H%s%N: Unable to set %H%s%N\r\n"
     49 #string STR_BCFG_VAR_NO_NUM       #language en-US "%H%s%N: Cannot create Key#### variable: All the numbers from 0x0000 - 0xFFFF have been used.\r\n"
     50 #string STR_BCFG_NUMB_RANGE       #language en-US "%H%s%N: Numbers must be under %d.\r\n"
     51 #string STR_BCFG_NONE             #language en-US "No options found.\r\n"
     52 
     53 #string STR_BCFG_LOCATION_RANGE   #language en-US "target location must be <= %d.\r\n"
     54 #string STR_BCFG_LOAD_OPTIONS     #language en-US "Option: %B%02x%N. Variable: %B%-11s%N\r\n"
     55                                                   "  Desc    - %s\r\n"
     56                                                   "  DevPath - %s\r\n"
     57                                                   "  Optional- %c\r\n"
     58 #string STR_GET_HELP_BCFG         #language en-US ""
     59 ".TH bcfg 0 "configure boot and driver"\r\n"
     60 ".SH NAME\r\n"
     61 "Manages the boot and driver options that are stored in NVRAM.\r\n"
     62 ".SH SYNOPSIS\r\n"
     63 " \r\n"
     64 "BCFG driver|boot [dump [-v]] [add # file "desc"] [addp # file "desc"] \r\n"
     65 "                 [addh # handle "desc"] [rm #] [mv # #] \r\n"
     66 "                 [-opt # [[filename]|["data"]] | \r\n"
     67 "                         [KeyData <ScanCode UnicodeChar>]]\r\n"
     68 ".SH OPTIONS\r\n"
     69 " \r\n"
     70 "  -v          - Displays verbose information about options, including the optional\r\n"
     71 "                data.\r\n"
     72 "  -opt        - Displays or modifies the optional data associated with a \r\n"
     73 "                driver or boot option. This parameter is followed by the file name of the\r\n"
     74 "                file that contains the binary data to be associated with the\r\n"
     75 "                driver or boot option optional data, or the quote\r\n"
     76 "                delimited data to be associated with the driver or\r\n"
     77 "                boot option optional data.\r\n"
     78 "  driver      - Displays or modifies the driver option list.\r\n"
     79 "  boot        - Displays or modifies the boot option list.\r\n"
     80 "  dump        - Displays the option list.\r\n"
     81 "  add         - Adds an option. The # is the number of options to add in\r\n"
     82 "                hexadecimal format. The file name is the name of the UEFI application/driver for\r\n"
     83 "                the option. The quoted parameter is the description of the\r\n"
     84 "                option to be added.\r\n"
     85 "  addh        - Adds an option that refers to the driver specified by a handle.\r\n"
     86 "                The # is the number of options to add, in hexadecimal format. The\r\n"
     87 "                handle is the driver handle, in hexadecimal format. The device path\r\n"
     88 "                for the option is retrieved from the handle. The quoted\r\n"
     89 "                parameter is the description of the option to be added.\r\n"
     90 "  addp        - Adds an option that refers to a specific file. Only the portion\r\n"
     91 "                of the device path starting with the hard drive partition is\r\n"
     92 "                placed in the option. The # is the number of options to add,\r\n"
     93 "                in hexadecimal format. The quoted parameter is the description of the\r\n"
     94 "                option being added.\r\n"
     95 "  rm          - Removes an option. The parameter lists the number of the options\r\n"
     96 "                to remove in hexadecimal format.\r\n"
     97 "  mv          - Moves an option. The first numeric parameter is the number of\r\n"
     98 "                the option to move in hexadecimal format. The second numeric parameter\r\n"
     99 "                is the new number of the option to be moved.\r\n"
    100 "  KeyData     - Specifies the packed value associated with a hot-key.\r\n"
    101 "  ScanCode    - Specifies the UEFI-defined scan code portion of the\r\n"
    102 "                EFI_INPUT_KEY instruction. This value is directly associated\r\n"
    103 "                with the preceding KeyData value. When one instance of this\r\n"
    104 "                parameter has a non-zero value, the paired UnicodeChar value\r\n"
    105 "                will have a zero-based value.\r\n"
    106 "  UnicodeChar - Specifies the Unicode value for the character associated with\r\n"
    107 "                the preceding KeyData value. When one instance of this\r\n"
    108 "                parameter has a non-zero value, the paired ScanCode value\r\n"
    109 "                will have a zero-based value.\r\n"
    110 ".SH DESCRIPTION\r\n"
    111 " \r\n"
    112 "NOTES:\r\n"
    113 "  1. This command manages the boot and driver options stored in NVRAM.\r\n"
    114 "  2. Use the dump option to display Boot#### or Driver#### environment variables.\r\n"
    115 "  3. Use the add option to add a new Boot#### or Driver#### \r\n"
    116 "     environment variable.\r\n"
    117 "  4. Use the rm option to delete a Boot#### or Driver#### \r\n"
    118 "     environment variable, and then the mv option to reorder\r\n"
    119 "     the Boot#### and Driver#### environment variables.\r\n"
    120 "  5. The add, rm, and mv options also update the BootOrder or DriverOrder\r\n"
    121 "     environment variables, as appropriate.\r\n"
    122 ".SH EXAMPLES\r\n"
    123 " \r\n"
    124 "EXAMPLES:\r\n"
    125 "  * To display driver options:\r\n"
    126 "    Shell> bcfg driver dump\r\n"
    127 " \r\n"
    128 "  * To display boot options:\r\n"
    129 "    Shell> bcfg boot dump\r\n"
    130 " \r\n"
    131 "  * To display verbose information about boot options:\r\n"
    132 "    Shell> bcfg boot dump -v\r\n"
    133 " \r\n"
    134 "  * To add a driver option #5:\r\n"
    135 "    Shell> bcfg driver add 5 mydriver.efi "My Driver"\r\n"
    136 " \r\n"
    137 "  * To add a boot option #3:\r\n"
    138 "    Shell> bcfg boot add 3 osloader.efi "My OS"\r\n"
    139 " \r\n"
    140 "  * To remove boot option #3:\r\n"
    141 "    Shell> bcfg boot rm 3\r\n"
    142 " \r\n"
    143 "  * To move boot option #3 to boot option #7:\r\n"
    144 "    Shell> bcfg boot mv 3 7\r\n"
    145 " \r\n"
    146 "  * To assign a CTRL-B hot-key to boot option #3:\r\n"
    147 "    Shell> bcfg boot -opt 3 0x40000200 0 0x42\r\n"
    148 ".SH RETURNVALUES\r\n"
    149 " \r\n"
    150 "RETURN VALUES:\r\n"
    151 "  SHELL_SUCCESS             The action was completed as requested.\r\n"
    152 "  SHELL_NOT_FOUND           The requested option was not found.\r\n"
    153 "  SHELL_INVALID_PARAMETER   One of the passed-in parameters was incorrectly\r\n"
    154 "                            formatted or its value was out of bounds.\r\n"
    155 "  SHELL_UNSUPPORTED         The action as requested was unsupported.\r\n"
    156 "  SHELL_SECURITY_VIOLATION  This function was not performed due to a security\r\n"
    157 "                            violation.\r\n"
    158 "  SHELL_OUT_OF_RESOURCES    There was insufficient free space for the request\r\n"
    159 "                            to be completed.\r\n"
    160 
    161