iPXE
branding.h
Go to the documentation of this file.
1 #ifndef CONFIG_BRANDING_H
2 #define CONFIG_BRANDING_H
3 
4 /** @file
5  *
6  * Branding configuration
7  *
8  */
9 
10 FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
11 
12 #include <config/defaults.h>
13 
14 /*
15  * Branding
16  *
17  * Vendors may use these strings to add their own branding to iPXE.
18  * PRODUCT_NAME is displayed prior to any iPXE branding in startup
19  * messages, and PRODUCT_SHORT_NAME is used where a brief product
20  * label is required (e.g. in BIOS boot selection menus).
21  *
22  * To minimise end-user confusion, it's probably a good idea to either
23  * make PRODUCT_SHORT_NAME a substring of PRODUCT_NAME or leave it as
24  * "iPXE".
25  *
26  */
27 #define PRODUCT_NAME ""
28 #define PRODUCT_SHORT_NAME "iPXE"
29 #define PRODUCT_URI "http://ipxe.org"
30 
31 /*
32  * Tag line
33  *
34  * If your PRODUCT_SHORT_NAME is longer than the four characters used
35  * by "iPXE", then the standard tag line "Open Source Network Boot
36  * Firmware" is unlikely to fit neatly onto the screen.
37  */
38 #define PRODUCT_TAG_LINE "Open Source Network Boot Firmware"
39 
40 /*
41  * Error messages
42  *
43  * iPXE error messages comprise a summary error message
44  * (e.g. "Permission denied") and a 32-bit error number. This number
45  * is incorporated into an error URI such as
46  *
47  * "No such file or directory (http://ipxe.org/2d0c613b)"
48  *
49  * or
50  *
51  * "Operation not supported (http://ipxe.org/3c092003)"
52  *
53  * Users may browse to the URI within the error message, which is
54  * provided by a database running on the iPXE web site
55  * (http://ipxe.org). This database provides details for all possible
56  * errors generated by iPXE, including:
57  *
58  * - the detailed error message (e.g. "Not an OCSP signing
59  * certificate") to complement the summary message (e.g. "Permission
60  * denied") which is compiled into the iPXE binary.
61  *
62  * - an instruction to the user to upgrade, if the error cannot be
63  * generated by the latest version of iPXE.
64  *
65  * - hints on how to fix the error (e.g. "This error indicates that
66  * the file was not found on the TFTP server. Check that you can
67  * retrieve the file using an alternative TFTP client, such as
68  * tftp-hpa on Linux.")
69  *
70  * - details of which source file within the iPXE codebase generated
71  * the error.
72  *
73  * - a direct link to the line(s) of code which generated the error.
74  *
75  * If you have a customer support team and would like your customers
76  * to contact your support team for all problems, instead of using the
77  * existing support infrastructure provided by http://ipxe.org, then
78  * you may define a custom URI to be included within error messages.
79  *
80  * Note that the custom URI is a printf() format string which must
81  * include a format specifier for the 32-bit error number.
82  */
83 #define PRODUCT_ERROR_URI "http://ipxe.org/%08x"
84 
85 /*
86  * Command help messages
87  *
88  * iPXE command help messages include a URI constructed from the
89  * command name, such as
90  *
91  * "See http://ipxe.org/cmd/vcreate for further information"
92  *
93  * The iPXE web site includes documentation for the commands provided
94  * by the iPXE shell, including:
95  *
96  * - details of the command syntax (e.g. "vcreate --tag <tag>
97  * [--priority <priority>] <trunk interface>").
98  *
99  * - example usages of the command (e.g. "vcreate --tag 123 net0")
100  *
101  * - a formal description of the command (e.g. "Create a VLAN network
102  * interface on an existing trunk network interface. The new network
103  * interface will be named by appending a hyphen and the VLAN tag
104  * value to the trunk network interface name.")
105  *
106  * - details of the possible exit statuses from the command.
107  *
108  * - links to documentation for related commands (e.g. "vdestroy")
109  *
110  * - links to documentation for relevant build options (e.g. "VLAN_CMD").
111  *
112  * - general hints and tips on using the command.
113  *
114  * If you want to provide your own documentation for all of the
115  * commands provided by the iPXE shell, rather than using the existing
116  * support infrastructure provided by http://ipxe.org, then you may
117  * define a custom URI to be included within command help messages.
118  *
119  * Note that the custom URI is a printf() format string which must
120  * include a format specifier for the command name.
121  *
122  * [ Please also note that the existing documentation is licensed
123  * under Creative Commons terms which require attribution to the
124  * iPXE project and prohibit the alteration or removal of any
125  * references to "iPXE". ]
126  */
127 #define PRODUCT_COMMAND_URI "http://ipxe.org/cmd/%s"
128 
129 /*
130  * Setting help messages
131  *
132  * iPXE setting help messages include a URI constructed from the
133  * setting name, such as
134  *
135  * "http://ipxe.org/cfg/initiator-iqn"
136  *
137  * The iPXE web site includes documentation for the settings used by
138  * iPXE, including:
139  *
140  * - details of the corresponding DHCP option number.
141  *
142  * - details of the corresponding ISC dhcpd option name.
143  *
144  * - examples of using the setting from the iPXE command line, or in
145  * iPXE scripts.
146  *
147  * - examples of configuring the setting via a DHCP server.
148  *
149  * - a formal description of the setting.
150  *
151  * - links to documentation for related settings.
152  *
153  * - links to documentation for relevant build options.
154  *
155  * - general notes about the setting.
156  *
157  * If you want to provide your own documentation for all of the
158  * settings used by iPXE, rather than using the existing support
159  * infrastructure provided by http://ipxe.org, then you may define a
160  * custom URI to be included within setting help messages.
161  *
162  * Note that the custom URI is a printf() format string which must
163  * include a format specifier for the setting name.
164  *
165  * [ Please also note that the existing documentation is licensed
166  * under Creative Commons terms which require attribution to the
167  * iPXE project and prohibit the alteration or removal of any
168  * references to "iPXE". ]
169  */
170 #define PRODUCT_SETTING_URI "http://ipxe.org/cfg/%s"
171 
172 #include <config/local/branding.h>
173 
174 #endif /* CONFIG_BRANDING_H */
FILE_LICENCE(GPL2_OR_LATER_OR_UBDL)