Command-line Options
Every option bizmuth takes, grouped by what it is for. bizmuth --help prints the same list with the parser’s own wording, and bizmuth --version the version and build.
bizmuth --machine next --sd next.img --load game.nexAn option that has a config key overrides it for that run without changing the file. --roms-dir is the exception: it is written back. See Config File.
Machine and media
| Option | Effect |
|---|---|
FILE | open a file by its extension: a program as --load does, a .tap or .tzx as --tape, a .dsk or .edsk in drive A, a .bzst as --loadstate. Without --machine, the file chooses the machine, as File ▸ Open does; see Loading Software |
--machine KIND | 16k, 48k, 128k, plus2a, plus3 or next. Without it, a .z80 or .sna given to --load runs on the machine it was taken on; otherwise default_machine from the config decides |
--roms-dir DIR | the folder holding the ROMs and the SD image; written to the config |
--board ks1|ks2|ks3 | the Next board for this run: KS1 (issue 2), KS2 (issue 4) or KS3 (issue 5) |
--ks1-ram 1|2 | the KS1’s RAM in MB for this run |
--sd IMAGE, --sd1 IMAGE | attach a card to slot 0 or slot 1 for this run. --sd0 is another name for --sd |
--sd-ro | attach both slots read-only for this run |
--flash IMAGE | load the Next’s configuration flash, 32 MB or 16 MB on KS1, from IMAGE for this run; programs and erases are written back to it. A shorter image is followed by erased $FF bytes, and a longer one is refused |
--flash-ro | keep flash programs and erases in memory, leaving the image unchanged |
--tape FILE | insert a .tap or .tzx. On the Next it plays at tape speed |
--tape-mode fast|real | override the loading mode the tape’s format picks |
--load FILE | load a .nex, .fxi, .snx, .sna or .z80 once the machine has booted. Given more than once, each file loads in order over the one before. --nex and --snapshot are older names |
--load-with PATH | place a file or folder on the card beside a --load program. Repeat for each |
--nex-route auto|inject|nexload | how a .nex reaches the Next; see Loading Software |
--no-boot-cache | boot for --load every time, and keep no saved boot |
--max-boot-frames N | give up on a --load boot that never goes idle after N frames, 1300 by default |
--loadstate FILE | restore a save state in place of booting; see Save States |
Window
| Option | Effect |
|---|---|
--player | full screen with no menu bar, toolbar or status bar; the controller overlay is the only chrome. Nothing it runs with is written back; see Controller Overlay |
--config FILE | read and write this config file in place of ~/.bizmuth/config.json |
--log-file FILE | write the log to a file as well as the terminal, from the first line |
Emulation
| Option | Effect |
|---|---|
--max-speed N | a ceiling on the Next’s CPU speed: 0 3.5 MHz, 1 7, 2 14, 3 28 |
--mem-wait, --no-mem-wait | put in or leave out the 28 MHz memory wait state |
--im2-daisy, --no-im2-daisy | put in or leave out the IM2 hardware interrupt vector |
--rtc, --no-rtc | run as a Next with or without a real-time clock fitted |
--video-output vga|hdmi | which of the Next’s connectors is watched, for this run; see Preferences |
--esp null|loopback|bridge|esp | what the Next’s ESP serial line is wired to; see ESP and Serial |
--esp-port N | the TCP port --esp bridge listens on, 11002 by default |
Each pair overrides the config’s setting for one run. Given both flags of a pair, the later one is used: --no-rtc --rtc runs with a clock fitted.
Debugger
| Option | Effect |
|---|---|
--debug-protocol none|adp|dzrp|both | the debug servers to start; see ADP and DeZog |
--adp-port N | the ADP port, 11001 by default |
--adp-bind ADDRESS | the address ADP listens on, every IPv4 interface by default; 127.0.0.1 accepts this machine only |
--sld FILE | load an SLD or a symbol export. Repeat for a program built as several images |
--script FILE | load a Rhai script; see Rhai Scripting |
--pc-trace FILE | append every instruction’s pc sp to a file. Next only |
--pc-trace-from N, --pc-trace-to N | the first and last frame --pc-trace records |
--esxdos-trace | log every esxDOS and NextZXOS RST $08 call. Next only |
--inspect-snapshot FILE | print a .sna, .snx or .z80 file’s contents and exit. --dump-snapshot is another name |
Headless runs
These run with no window. See Headless Runs and Testing.
| Option | Effect |
|---|---|
--screenshot FILE.png | run a number of frames, save the screen, and exit |
--screenshot-frames N | the frames a --screenshot or --video run lasts, 600 by default |
--video FILE.png | record every frame of the run as an animated PNG |
--keys SCRIPT | press keys at given frames |
--mouse SCRIPT | move the mouse and press its buttons at given frames |
--auto-keys [FRAME] | press ENTER once from this frame, 160 if none is given, to answer the Next’s boot prompt |
--select | press ENTER once the browser is up, to launch the highlighted entry |
--savestate FILE | write a compressed save state at the end |
--savestate-raw FILE | write an uncompressed save state at the end |
--state-json FILE | write the machine state as JSON at the end |
--headless | run with the debug servers and no window until stopped |
--run-tests FILE | run a FantASM test description file and exit |
--image-org ADDRESS | where a flat .bin image named by --run-tests loads |
Audio
| Option | Effect |
|---|---|
--wav FILE | write what goes to the speakers to a 32-bit float WAVE file. With a window only |
--wav-sources DIR | write the beeper, AY and DAC each to its own WAVE file in DIR. Next only |