Files
linux-kernel-module-cheat/run-usage.adoc
Ciro Santilli 29908dffb2 Disable networking at runtime with lkmc_nonet cli instead of build
This is necessary because qemu and gem5 now use the same build folder.

Separate ./run -e and -f for kernel options before and after the ' - '.
This was already the better thing to do when -E was introduced,
but lkmc_nonet prompted me to do it nicer now.

Use the common script to find the out_dir on every toplevel script.

Include usage man pages on README.
2018-03-22 02:47:14 +00:00

40 lines
2.1 KiB
Plaintext

= run usage
....
./run [OPTIONS] [-- EXTRA_RUN_ARGS]`
....
[options="header"]
|===
|Name |Argument name | Description
|`-a` |`ARCH` | Run architecture `ARCH`.
|`-c` |`NCPUS` | Emulate `NCPUS` guest CPUs.
|`-D` | | Run GDB on the emulator itself.
|`-d` | | Run in debug mode, expect a GDB connection to guest.
|`-E` |`CMDSTR` | Replace the normal init with a minimal init that just evals
with given `CMDSTR` bash command string. Example:
`-E 'insmod /hello.ko;'`
|`-e` |`CLI_OPTIONS` | Pass an extra Linux kernel command line options,
and place them before the dash separator `-`.
Only options that come before the `-`, i.e. "standard"
options, should be passed with this option.
Example: `./run -a arm -e 'init=/poweroff.out'`
|`-f` |`CLI_OPTIONS` | Pass an extra Linux kernel command line options,
add a dash `-` separator, and place the options after the dash.
Intended for custom options understood by our `init` scripts,
most of which are prefixed by `lkmc_`, e.g.:
`./run -f 'lkmc_eval="wget google.com" lkmc_nonet=y'`
Mnenomic: comes after `-e`.
|`-K` | | Use KVM. Only works if guest arch == host arch.
|`-k` | | Enable KGDB.
|`-G` | | Pass extra options to the gem5 executable.
Only useful if `-g` is given.
Do not confuse with the arguments passed to the config scripts,
e.g. `fs.py`
|`-h` | | Show this help message.
|`-I` | | Run with initramfs.
|`-i` | | Run with initrd.
|`-m` | | Set the memory size of the guest. E.g.: `-m 512M`. Default: `256M`.
|`-n` | | Run in nographic mode.
|===