Skip to content

ROMs: Describe the command line arguments that affect the search path - #75

Open
perchrh wants to merge 1 commit into
86Box:masterfrom
perchrh:rom-search-path-options
Open

perchrh wants to merge 1 commit into
86Box:masterfrom
perchrh:rom-search-path-options

Conversation

@perchrh

@perchrh perchrh commented Nov 18, 2026 •

Copy link
Copy Markdown

Prerequisite met

Now merged and ready:
Depends on #15 (search the VM-local ROM and asset paths when the config is given as an argument). Without that fix, the text about -C/the positional configuration file is not true for 86Box.

Changes

Adds a "Command line arguments" part to the ROM search path section of usage/roms.rst:

  • -R/--rompath path: added to the start of the search path; can be given more than once, searched in the order given; relative paths are relative to the current working directory.
  • -P/--vmpath path: sets the VM path, whose roms subdirectory is searched first after any -R paths.
  • -C/--config file, or the configuration file as the last argument: without -P, the VM path is the configuration file's directory, with a note that 86Box 6.0 and older used the current working directory instead.
  • -Z/--lastvmpath: the last argument is the VM path instead of a configuration file.

Based on master, which holds the docs for the upcoming 86Box 7.0 ("latest" on Read the Docs); the v6.0 and older branches are not changed.

Testing

Built with the pinned requirements (Sphinx 8.2.3, sphinx-rtd-theme 3.0.2, linuxdoc); the page renders without warnings.

AI disclosure

Generated with Claude Code

Document -R/--rompath, -P/--vmpath, -C/--config (or the configuration
file as the last argument) and -Z/--lastvmpath, including that the VM
path is the configuration file's directory when -P is not used.

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant