Bump Standards-Version to 3.9.6
[grml2usb.git] / grml2iso.8.txt
1 grml2iso(8)
2 ==========
3
4 Name
5 ----
6 grml2iso - create a multiboot Grml ISO using grml2usb
7
8 Synopsis
9 --------
10 grml2iso -o <target.iso> <ISO[s]>
11
12 *******************************************************************************
13 Important! The grml team does not take responsibility for loss of any data!
14 *******************************************************************************
15
16 Introduction
17 ------------
18
19 grml2iso allows you to create a multiboot Grml ISO. You can specify
20 two or more Grml ISOs and will get one single multiboot ISO as a result.
21 grml2iso requires and uses grml2usb for this task and installs grub2
22 as bootmanager on the multiboot ISO.
23
24 Options
25 -------
26
27 grml2iso supports the environment variables GRML2USB and WRKDIR.
28 GRML2USB specifies the path to the grml2usb script you'd like to use.
29 WRKDIR specifies the work directory for creating the filesystem.
30 The work directory needs at least as much free disk space as the sum
31 of all specified ISOs.
32
33   *-o <target.iso>*::
34
35 This option is mandatory and specifies where the resulting multiboot Grml ISO
36 should be placed. Note that (to avoid any possible data loss) grml2iso will exit
37 if the specified target.iso exists already.
38
39   *-c <directory>*::
40
41 The content of the specified directory will be copied to the resulting
42 multiboot Grml ISO.
43
44   *-b <boot params>*::
45
46 Use specified default bootoptions as default.
47
48   *-f*::
49
50 Force the program to run and overwrite an existing ISO image.
51
52   *-r <boot param>*::
53
54 Remove specified boot parameter from existing command line. Could be specified multiple times.
55
56   *-p <grml2usb param>*::
57
58 Execute grml2usb with the specified parameters. For a list of valid parameters have a look at the link:http://grml.org/grml2usb/[grml2usb webpage] or the grml2usb manpage
59
60   *-s <URI>*::
61
62 Generate a small ISO file which downloads the squashfs file from the
63 specified URI. Due  to current limitations in busyboxs wget and DNS
64 resolution, an URL can not contain a hostname but an IP only. This is
65 useful if you want to boot systems which support booting ISO image from
66 your local system. Besides the iso image this command also copies the
67 squashfs file to the output directory.
68
69 Usage examples
70 --------------
71
72   # grml2iso -o /tmp/grml.iso grml_2009.05.iso grml64_2009.05.iso
73
74 Create multiboot ISO /tmp/grml.iso with grml_2009.05.iso and grml64_2009.05.iso.
75
76  # grml2iso -b 'lang=de ssh=passwd' -c /tmp/grml-content -o /srv/grml.iso /srv/grml/grml_2009.10.iso
77
78 Create a new ISO with additional boot parameters and copy the content
79 from /tmp/grml-content to the generated ISO image.
80
81   # grml2iso -r quiet -r vga=791 -o /srv/grml.iso /srv/grml-small_2009.10.iso
82
83 Create a new ISO and remove existing boot parameters quiet and vga=791.
84
85   # GRML2USB=/srv/git/grml2usb grml2iso -o /srv/grml.iso /srv/grml/grml_2009.05.iso /srv/grml/grml64-medium_2009.05.iso
86
87 Create multiboot ISO /srv/grml.iso with grml_2009.05.iso and
88 grml64-medium_2009.05.iso using /srv/git/grml2usb as grml2usb script.
89
90   # WRKDIR=/mnt/test/grml-tmp grml2iso -o /mnt/test/grml.iso grml_2009.05.iso grml64_2009.05.iso
91
92 Use /mnt/test/grml-tmp as working directory for creating the multiboot ISO
93 /mnt/test/grml.iso with grml_2009.05.iso and grml64_2009.05.iso.
94
95   # grml2iso -p --skip-addons -o /srv/grml.iso /srv/grml-small_2009.10.iso /srv/grml64-small_2009.10.iso
96
97 Don't copy the addons from the specified ISO images
98
99
100 Online Ressources
101 -----------------
102
103 Check out the link:http://grml.org/grml2usb/[grml2usb webpage] and the
104 link:http://git.grml.org/?p=grml2usb.git[grml2usb git repository].
105
106 Bugs
107 ----
108 Please report feedback, bugreports and wishes <<X7,to the author>>.
109
110 [[X7]]
111 Authors
112 -------
113 Michael Prokop <mika@grml.org> and Thorsten Glaser <tg@mirbsd.org>