osi-tools/README.md

34 lines
1.1 KiB
Markdown

# osi-tools: Operating System Image Tools
## Usage
$ ./osi-mk [FLAGS] SYS.img # to build an image
$ ./osi-shell SYS.img # launch an interactive shell in an emulator
$ sudo ./osi-mount --{root|user} SYS.img COMMAND # run command with SYS.img mounted
$ sudo ./osi-extract SYS.img IMAGE_SRC_DIR HOST_DST_DIR # to extract files from an image
## Dependencies
I believe the complete list of dependencies is (along with what I
believe is the newest feature that is depended on):
- arch-install-scripts
- btrfs-progs
- GNU Bash 4.4 (needs `@Q`)
- GNU coretutils 8.15 (needs `realpath`)
- GNU gettext
- QEMU (needs `qemu-system-x86_64`)
- sed
- sudo
- util-linux-ng 2.18 or newer (needs automatic loop devices in `mount`)
This can be install on a Parabola Parabola GNU/Linux-libre system with
the following command:
sudo pacman -S --needed arch-install-scripts btrfs-progs bash coreutils gettext qemu-system-x86 sed sudo util-linux
## Developing
You can lint the code in this repository by running `make lint`, which
requires the `shellcheck` command.