Redesign grml2usb
[grml2usb.git] / grml2usb.8.txt
1 grml2usb(8)
2 ==========
3
4 Name
5 ----
6 grml2usb - install grml on usb device
7
8 Synopsis
9 --------
10 grml2usb [ options ] <ISO[s]> <device>
11
12 *******************************************************************************
13 Important! The grml team does not take responsibility for loss of any data!
14 *******************************************************************************
15
16 Options
17 -------
18
19   *--fat16*::
20
21 Format specified partition with FAT16.
22
23   *--grub*::
24
25 Install grub bootloader instead of syslinux.
26
27   *--mbr*::
28
29 Install master boot record (MBR) on the device.
30
31   *--syslinux*::
32
33 Install syslinux bootloader (default, requires FAT16 filesystem on the specified partition).
34
35   *-v*::
36
37 Return version and exit.
38
39   *-V*::
40
41 Enable verbose mode.
42
43 Introduction
44 ------------
45
46 grml2usb installs grml on a given partition on your usb device and makes it
47 bootable.
48
49 Directory layout on usb device
50 ------------------------------
51
52   boot/ ->
53     |-- addons/
54     |   |-- allinone.img
55     |   |-- balder10.imz
56     |   |-- chain.c32
57     |   |-- memdisk
58     |   `-- menu.c32
59     |-- release/
60     |   |-- grml/
61     |       |-- linux26
62     |       |-- initrd.gz
63     |   |-- grml64
64     |       |-- linux26
65     |       |-- initrd.gz
66     |   |-- grml-medium
67     |       |-- linux26
68     |       |-- initrd.gz
69     |   |-- grml64-medium
70     |       |-- linux26
71     |       |-- initrd.gz
72     |   |-- grml-small
73     |       |-- linux26
74     |       |-- initrd.gz
75     |   |-- grml64-small
76     |       |-- linux26
77     |       |-- initrd.gz
78     |-- grub/
79     |   |-- menu.lst
80     |   |-- splash.xpm.gz
81     |   |-- stage2_eltorito
82     |-- isolinux/
83     |   |-- boot.msg
84     |   |-- boot-beep.msg
85     |   |-- logo.16
86     |   |-- isolinux-main.cfg
87     |   |-- isolinux.cfg
88     |   |-- syslinux.cfg
89     `-- bootsplashes/
90         |-- f1
91         |-- f2
92         |-- f3
93         |-- f4
94         |-- f5
95         |-- f6
96         |-- f7
97         |-- f8
98         |-- f9
99         `-- f10
100
101   grml/
102     |-- grml2usb.txt
103     |-- grml-cheatcodes.txt
104     |-- grml-version.txt
105     |-- LICENSE.txt
106     |-- md5sums
107     |-- README.txt
108     |-- web/
109         |-- index.html
110         |-- style.css
111         `-- images/
112             |-- button.png
113             |-- favicon.png
114             |-- linux.jpg
115             `-- logo.png
116
117   live/
118     |-- filesystem.module
119     |-- grml.squashfs
120     |-- grml-medium.module
121     |-- grml-medium.squashfs
122     |-- grml-small.module
123     |-- grml-small.squashfs
124     |-- grml64.module
125     |-- grml64.squashfs
126     |-- grml64-medium.module
127     |-- grml64-medium.squashfs
128     |-- grml64-small.module
129     `-- grml64-small.squashfs
130
131 Usage examples
132 --------------
133
134 TODO
135
136 Bugs
137 ----
138 Please report feedback, link:http://grml.org/bugs/[bugreports] and wishes link:http://grml.org/contact/[to us]!
139
140 Author
141 ------
142 Michael Prokop <mika@grml.org>