Skip to content

Commit

Permalink
README: cleanup man page
Browse files Browse the repository at this point in the history
in particular, remove mention of being able to specify hooks of a
different name than their builder. we don't actually support this right
now.
  • Loading branch information
falconindy committed May 21, 2011
1 parent 2c0b939 commit 596c7c6
Showing 1 changed file with 30 additions and 20 deletions.
50 changes: 30 additions & 20 deletions README.pod
Expand Up @@ -18,18 +18,20 @@ tailor the image to the system's hardware and software needs.


=item B<-b> I<basedir> =item B<-b> I<basedir>


Specify a base directory other than C</>. This is reserved for usage during a Specify a base directory other than C</>. This might be useful when mounting
chroot. geninit will attempt to use as much as possible from the guest system, another system from a rescue CD. geninit will attempt to use as much as
drawing only from the host system when necessary. possible from the guest system, drawing only from the host system when
necessary.


=item B<-c> I<config-file> =item B<-c> I<config-file>


Use an alterate config file. Defaults to C</etc/geninit.conf>. Use an alterate config file. Defaults to C</etc/geninit.conf>.


=item B<-g> I<imagename> =item B<-g> I<imagename>


Specify the absolute path of the generated initramfs image. If unspecified, Specify the absolute path of the generated initramfs. If not specified, and in
a dry-run will be performed and no image will be created. the absence of the B<-p> option, a dry-run will be performed and no image will
be created.


=item B<-H> I<builder> =item B<-H> I<builder>


Expand Down Expand Up @@ -74,10 +76,10 @@ needs to be a writeable directory with a minimum of 20mb free.
=item B<-z> I<compression> =item B<-z> I<compression>


Override the compression method specified by the config file. geninit supports Override the compression method specified by the config file. geninit supports
compression via B<gzip>, B<bzip2>, B<lzma>, and B<xz> (with optional support for compression via B<gzip>, B<bzip2>, B<lzma>, B<xz>, and B<lzop>. You can also use
B<lzop>). You can also use B<none> to disable compression. Please note that your B<none> to disable compression. Please note that your kernel must have support
kernel I<must> support your method and choice and your kernel will not be for this method. geninit will not make this check for you! If in doubt, gzip is
checked for this support! If in doubt, gzip is a safe choice. a safe choice.


=back =back


Expand Down Expand Up @@ -117,7 +119,7 @@ have been run, but prior to the root device being mounted.
=item B<init=>I<path> =item B<init=>I<path>


An optional parameter to specify an alternate init system for userspace. If not An optional parameter to specify an alternate init system for userspace. If not
specified, this defaults to /sbin/init. specified, this defaults to C</sbin/init>.


=item B<loglevel=>I<#> =item B<loglevel=>I<#>


Expand All @@ -139,17 +141,25 @@ This parameter, for obvious reasons, must be specified.


=item B<rootflags=>I<flags> =item B<rootflags=>I<flags>


A comma separated list of options passed directly to the final parameter of A comma separated list of filesystem specific options passed directly to the
B<mount>(2) when mounting the root device. final parameter of B<mount>(2) when mounting the root device. Do not attempt to
pass flags such as C<rw> or C<relatime> here.

=item B<rw>

Specifies that the root device should be mounted as read-write. This is usually
a bad idea. geninit will default to mounting the root device as read-only. It is
up to your B<init> to remount the device read-write (which usually occurs after
a fsck has been performed).


=back =back


=head1 BUILDERS =head1 BUILDERS


Builders are bash scripts that are executed during build time in order to add Builders are bash scripts that are executed during build time in order to add
functionality to the image. They are sourced from the appropriate config file, functionality to the image. They are sourced from geninit's config file, and
and run in array index order. Builders may draw in an additional hookscript for run in array index order. Builders may draw in an additional hookscript for use
use at runtime. at runtime.


At a minimum, builders must define a function called I<build>, which contains At a minimum, builders must define a function called I<build>, which contains
instructions on what geninit should add to the image. See the B<BUILDER API> instructions on what geninit should add to the image. See the B<BUILDER API>
Expand Down Expand Up @@ -247,8 +257,8 @@ add_checked_modules call will be added to the resulting image.


=item B<all_all_modules> I<class>... =item B<all_all_modules> I<class>...


Identical to B<add_checked_modules> with the exception that no comparison Similar to B<add_checked_modules>, excepting that no comparison against the
against the autodetected module list is performed. autodetected module list is performed.


=item B<add_file> I<source> [I<path>] =item B<add_file> I<source> [I<path>]


Expand Down Expand Up @@ -276,10 +286,10 @@ specified, the permissions of the FIFO will be 644.
Add a symlink to the image, located at the absolute path specified by link, Add a symlink to the image, located at the absolute path specified by link,
and pointing to the path specified by target. and pointing to the path specified by target.


=item B<use_hookscript> [I<script>] =item B<use_hookscript>


Indicate that a script should be added to be run during bootstrap. Unless Indicate that a script should be added to be run during bootstrap. geninit
specified, geninit will look for a script by the same name as the builder. will look to add a script by the same name as the builder.


=back =back


Expand Down

0 comments on commit 596c7c6

Please sign in to comment.