MODULE

light-os


SYNOPSIS

build_lightos [--help] [--version <name>] [--mount <dir>] [--inodes <num>] [--path <dir>] [--defconfig] [--config] [--clean] [--buildroot] [--initrd] [--modify] [--full]


DESCRIPTION

This build_lightos tool facilitates the creation of a light-os by automating the following steps:

By default, build_lightos will execute all three of the steps detailed above. However, should the user wish to execute the steps independently, one can specify one or more of the following options (--builroot, --initrd, --modify).

Typically, the light-os has been used in conjuction with a diskless systems that boot over the network using tftp and DHCP. However, the build_lightos tool does not make any assumptions about how a user might wish to boot a node. As such, this tool does not provide a kernel or any other configuration files (DHCP, pxeconfig) external to the root filesystem itself.


OPTIONS

--version <name> Which buildroot version to compile. If not specified, or if <name> matches multiple available versions, then the user will be prompted for a choice. <name> should be in the form of: buildroot-20051214

--mount <dir> Specify the directory on which the initrd should be mounted. If not specified, the default is /tftpboot/initrd_mnt.

--inodes <count> Specify the inode count for the new filesystem. If not specified, the default is 2000.

--path <path> The path to the new initrd. If not specified, the default is /tftpboot/initrd.

--defconfig Use buildroot's default configuration instead of the one that is provided as part of this module.

--configure Start the buildroot configuration interactive menu interface.


--clean
  Force a "make clean" before compiling
  buildroot.

--rootsrc <dir> The location of an existing rootfilesytem. Use this option when you already have a rootfilesystem and you just want to execute the initrd step. Used in conjunction with the --initrd option

--buildroot Create the root filesystem using buildroot. This option enables the user to build buildroot without executing any of the other steps.

--initrd Create the initrd and populate it with the new root filesystem. If this option is specified alone, then the --rootsrc option should be used to indicate the source for the new root filesystem.

--modify Modify the buildroot environment to boot the light-os.

--full This is the default option. It will perform all three of the necessary steps to create a working light-os (buildroot, initrd, and modify).