summaryrefslogtreecommitdiff
path: root/doc/gfxboot.8
blob: 10de696f319a4ffe9dbb409cd2dd58f43ed0bc60 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
.TH GFXBOOT 8 "July 2008" "gfxboot" "System configuration"
.\"
.SH NAME
gfxboot \- graphical boot screen test and config tool
.\"
.SH SYNOPSIS
.B gfxboot [
.I OPTIONS
.B ]
.I ARGS
.\"
.SH DESCRIPTION
.B gfxboot
modifies and tests graphical boot loader configuration.
.\"
.SH OPTIONS
.SS General options
.TP
\fB-a\fR, \fB--archive\fR \fIFILE\fR|\fIDIRECTORY\fR
Use FILE as gfxboot archive (default is /boot/message).
If it points to a directory, assume it is an expanded archive (see \fB--expand-archive\fR option below).
.TP
\fB-v\fR, \fB--verbose\fR
Increase verbosity.
.TP
\fB--save-temp\fR
Keep temporary files.
.TP
\fB--help\fR
Print usage.
.SS Switching themes
.TP
\fB--new-theme \fITHEME\fR
Activate THEME. Theme files are stored in /etc/bootsplash/themes/THEME/bootloader.
.TP
\fB--update-theme \fITHEME\fR
Activate THEME but keep language settings from current gfxboot archive.
.SS Changing gfxboot config
.TP
\fB--show-config\fR
Show gfxboot config file (gfxboot.cfg).
.TP
\fB--change-config \fR[\fISECTION1::\fR]\fIOPTION1\fR=\fIFOO1\fR [\fISECTION2::\fR]\fIOPTION2\fR=\fIFOO2\fR ...
Change gfxboot config options. If sections are omitted, section "base" is used.
.TP
\fB--rm-config \fR[\fISECTION1::\fR]\fIOPTION1\fR [\fISECTION2::\fR]\fIOPTION2\fR ...
Delete gfxboot config options. If sections are omitted, section "base" is used.
.TP
\fB--rm-section \fISECTION1\fR \fISECTION2\fR ...
Delete sections in gfxboot config file.
.TP
\fB--default-language \fILANG\fR
Make LANG the default language. LANG is a locale string (e.g. en_US).
.TP
\fB--add-languages \fILANG1\fR \fILANG2\fR ...
Add translation files.
.TP
\fB--rm-languages \fILANG1\fR \fILANG2\fR ...
Remove translation files.
.TP
\fB--config-file\fR \fIFILE\fR
Don't work on gfxboot.cfg from gfxboot archive but on FILE. NOTE: FILE will be modified even with "--test".
.SS Preview/test gfxboot setup
.TP
\fB-p\fR, \fB--preview \fR
Try current config (needs some virtual machine).
.TP
\fB-t\fR, \fB--test\fR
Test only (don't actually change any files).
.TP
\fB-b\fR, \fB--bootloader\fR \fIBOOTLOADER\fR
Use BOOTLOADER (grub, lilo, isolinux, syslinux) for preview.
.TP
\fB-m\fR, \fB--vm\fR \fIVM\fR
Use virtual machine VM (bochs, qemu, qemu-i386, qemu-x86_64, vbox, vboxsdl, vmplayer, vmware) for preview.
.TP
\fB--grub\fR \fIDIRECTORY|RPM\fR
Use grub from DIRECTORY or RPM (default is /).
.TP
\fB--lilo\fR \fIDIRECTORY|RPM\fR
Use lilo from DIRECTORY or RPM (default is /).
.TP
\fB--syslinux\fR \fIDIRECTORY|RPM\fR
Use syslinux from DIRECTORY or RPM (default is /).
.TP
\fB--isolinux\fR \fIDIRECTORY|RPM\fR
Use isolinux from DIRECTORY or RPM (default is /).
.TP
\fB--password\fR \fIPASSWORD\fR
Create test config with PASSWORD for preview.
.TP
\fB--biarch\fR
Create biarch test image.
.TP
\fB--cdrom\fR, \fB--dvd\fR
Create iso image for preview.
.TP
\fB--disk\fR
Create harddisk image for preview.
.TP
\fB--floppy\fR
Create floppy image for preview.
.TP
\fB--save-image\fR \fIFILE\fR
Copy preview image to FILE.
.SS Adding/removing files from gfxboot archive
.TP
\fB--ls\fR, \fB--list-files\fR
List gfxboot archive files.
.TP
\fB--add-files\fR \fIFILE1\fR \fIFILE2\fR ...
Add files to gfxboot archive.
.TP
\fB--extract-files\fR \fIFILE1\fR \fIFILE2\fR ...
Copy files from gfxboot archive to current working directory.
.TP
\fB--show-file\fR \fIFILE\fR
Print FILE.
.TP
\fB--expand-archive\fR \fIDIRECTORY\fR
Create expanded gfxboot archive version in DIRECTORY. That is, only files that
cannot be read directly from file system are kept in a cpio archive. All
others are unpacked.  Use only for isolinux and syslinux.
.TP
\fB--pack-archive\fR \fIFILE\fR
Pack all gfxboot files into cpio archive FILE.
.\"
.SS Modifying help files
.TP
\fB--help-show\fR \fIFILE\fR
Print FILE (internal help file format) as HTML.
.TP
\fB--help-create\fR \fIFILE\fR
Convert HTML files passed as ARGS to FILE (internal format).
.TP
\fB--used-pages\fR \fILINK1\fR \fILINK2\fR ...
Mark pages as referenced.
.TP
\fB--navi\fR \fIFILE\fR
Use FILE as template for navigation links.
.TP
\fB--define\fR \fIENTITY1\fR=\fIVALUE1\fR \fIENTITY2\fR=\fIVALUE2\fR ...
Define ENTITYx with VALUEx.
.SH FILES
.TP 18n
.B /boot/message
bootloader graphics archive (actually a cpio achive)
.TP
.B /etc/bootsplash/themes
theme directory
.TP
.B /etc/sysconfig/bootsplash
default theme
.\"
.SH BUGS
None.
.\"
.SH AUTHOR
.nf
Written by Steffen Winterfeldt.
.fi
.\"
.SH "SEE ALSO"
If you want to create your own theme look at the gfxboot-devel package.
.\"