Skip to content

Latest commit

 

History

History
53 lines (27 loc) · 1.74 KB

usage.md

File metadata and controls

53 lines (27 loc) · 1.74 KB

Usage

Once installed, ugrd can be executed as root to create an initramfs based on the definition in /etc/ugrd/config.toml.

Supplying configuration

Alternate configuration can be supplied with:

ugrd -c example_config.toml

Overriding the output location

The last argument is the output file, which can be a path:

ugrd /boot/ugrd.cpio

If no path information is supplied, the filename provided will be created under build_dir

Hostonly mode

The hostonly boolean is enabled by default and is required for validation.

hostonly mode is also required for most runtime config autodetection, since it's read from the build host.

It can be forced at runtime with --hostonly and disabled with --no-hostonly.

Validation mode

The validate option is set by default and attempts to verify that the generated initramfs will work on the system creating it.

It can be forced at runtime with --validate and disabled with --no-validate.

Build logging

To enable verbose logging of what is being moved into the initramfs build directory, set build_logging to true, or enable it at runtime with --build-logging.

This option will bump the log level of build operations to at least INFO (20).

This can be enabled at runtime with --build-logging or disabled with --no-build-logging

The output can be logged to a file instead of stdout by specifying a log file with --log-file

Output

An initramfs environment will be generated at build_dir (/tmp/initramfs/).

The initramfs will be packed to out_dir (/tmp/initramfs_out) and named out_file (ugrd.cpio).

Image configuration/information

The final config dict can be printed with --print-config.

A list of functions by runlevel can be printed with --print-init.