iPXE
branding.h
Go to the documentation of this file.
00001 #ifndef CONFIG_BRANDING_H
00002 #define CONFIG_BRANDING_H
00003 
00004 /** @file
00005  *
00006  * Branding configuration
00007  *
00008  */
00009 
00010 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
00011 
00012 #include <config/defaults.h>
00013 
00014 /*
00015  * Branding
00016  *
00017  * Vendors may use these strings to add their own branding to iPXE.
00018  * PRODUCT_NAME is displayed prior to any iPXE branding in startup
00019  * messages, and PRODUCT_SHORT_NAME is used where a brief product
00020  * label is required (e.g. in BIOS boot selection menus).
00021  *
00022  * To minimise end-user confusion, it's probably a good idea to either
00023  * make PRODUCT_SHORT_NAME a substring of PRODUCT_NAME or leave it as
00024  * "iPXE".
00025  *
00026  */
00027 #define PRODUCT_NAME ""
00028 #define PRODUCT_SHORT_NAME "iPXE"
00029 #define PRODUCT_URI "http://ipxe.org"
00030 
00031 /*
00032  * Tag line
00033  *
00034  * If your PRODUCT_SHORT_NAME is longer than the four characters used
00035  * by "iPXE", then the standard tag line "Open Source Network Boot
00036  * Firmware" is unlikely to fit neatly onto the screen.
00037  */
00038 #define PRODUCT_TAG_LINE "Open Source Network Boot Firmware"
00039 
00040 /*
00041  * Error messages
00042  *
00043  * iPXE error messages comprise a summary error message
00044  * (e.g. "Permission denied") and a 32-bit error number.  This number
00045  * is incorporated into an error URI such as
00046  *
00047  *   "No such file or directory (http://ipxe.org/2d0c613b)"
00048  *
00049  * or
00050  *
00051  *   "Operation not supported (http://ipxe.org/3c092003)"
00052  *
00053  * Users may browse to the URI within the error message, which is
00054  * provided by a database running on the iPXE web site
00055  * (http://ipxe.org).  This database provides details for all possible
00056  * errors generated by iPXE, including:
00057  *
00058  * - the detailed error message (e.g. "Not an OCSP signing
00059  *   certificate") to complement the summary message (e.g. "Permission
00060  *   denied") which is compiled into the iPXE binary.
00061  *
00062  * - an instruction to the user to upgrade, if the error cannot be
00063  *   generated by the latest version of iPXE.
00064  *
00065  * - hints on how to fix the error (e.g. "This error indicates that
00066  *   the file was not found on the TFTP server.  Check that you can
00067  *   retrieve the file using an alternative TFTP client, such as
00068  *   tftp-hpa on Linux.")
00069  *
00070  * - details of which source file within the iPXE codebase generated
00071  *   the error.
00072  *
00073  * - a direct link to the line(s) of code which generated the error.
00074  *
00075  * If you have a customer support team and would like your customers
00076  * to contact your support team for all problems, instead of using the
00077  * existing support infrastructure provided by http://ipxe.org, then
00078  * you may define a custom URI to be included within error messages.
00079  *
00080  * Note that the custom URI is a printf() format string which must
00081  * include a format specifier for the 32-bit error number.
00082  */
00083 #define PRODUCT_ERROR_URI "http://ipxe.org/%08x"
00084 
00085 /*
00086  * Command help messages
00087  *
00088  * iPXE command help messages include a URI constructed from the
00089  * command name, such as
00090  *
00091  *   "See http://ipxe.org/cmd/vcreate for further information"
00092  *
00093  * The iPXE web site includes documentation for the commands provided
00094  * by the iPXE shell, including:
00095  *
00096  * - details of the command syntax (e.g. "vcreate --tag <tag>
00097  *   [--priority <priority>] <trunk interface>").
00098  *
00099  * - example usages of the command (e.g. "vcreate --tag 123 net0")
00100  *
00101  * - a formal description of the command (e.g. "Create a VLAN network
00102  *   interface on an existing trunk network interface. The new network
00103  *   interface will be named by appending a hyphen and the VLAN tag
00104  *   value to the trunk network interface name.")
00105  *
00106  * - details of the possible exit statuses from the command.
00107  *
00108  * - links to documentation for related commands (e.g. "vdestroy")
00109  *
00110  * - links to documentation for relevant build options (e.g. "VLAN_CMD").
00111  *
00112  * - general hints and tips on using the command.
00113  *
00114  * If you want to provide your own documentation for all of the
00115  * commands provided by the iPXE shell, rather than using the existing
00116  * support infrastructure provided by http://ipxe.org, then you may
00117  * define a custom URI to be included within command help messages.
00118  *
00119  * Note that the custom URI is a printf() format string which must
00120  * include a format specifier for the command name.
00121  *
00122  * [ Please also note that the existing documentation is licensed
00123  *   under Creative Commons terms which require attribution to the
00124  *   iPXE project and prohibit the alteration or removal of any
00125  *   references to "iPXE". ]
00126  */
00127 #define PRODUCT_COMMAND_URI "http://ipxe.org/cmd/%s"
00128 
00129 /*
00130  * Setting help messages
00131  *
00132  * iPXE setting help messages include a URI constructed from the
00133  * setting name, such as
00134  *
00135  *   "http://ipxe.org/cfg/initiator-iqn"
00136  *
00137  * The iPXE web site includes documentation for the settings used by
00138  * iPXE, including:
00139  *
00140  * - details of the corresponding DHCP option number.
00141  *
00142  * - details of the corresponding ISC dhcpd option name.
00143  *
00144  * - examples of using the setting from the iPXE command line, or in
00145  *   iPXE scripts.
00146  *
00147  * - examples of configuring the setting via a DHCP server.
00148  *
00149  * - a formal description of the setting.
00150  *
00151  * - links to documentation for related settings.
00152  *
00153  * - links to documentation for relevant build options.
00154  *
00155  * - general notes about the setting.
00156  *
00157  * If you want to provide your own documentation for all of the
00158  * settings used by iPXE, rather than using the existing support
00159  * infrastructure provided by http://ipxe.org, then you may define a
00160  * custom URI to be included within setting help messages.
00161  *
00162  * Note that the custom URI is a printf() format string which must
00163  * include a format specifier for the setting name.
00164  *
00165  * [ Please also note that the existing documentation is licensed
00166  *   under Creative Commons terms which require attribution to the
00167  *   iPXE project and prohibit the alteration or removal of any
00168  *   references to "iPXE". ]
00169  */
00170 #define PRODUCT_SETTING_URI "http://ipxe.org/cfg/%s"
00171 
00172 #include <config/local/branding.h>
00173 
00174 #endif /* CONFIG_BRANDING_H */