furnace/doc/8-advanced/commandline.md

40 lines
1.7 KiB
Markdown
Raw Normal View History

2023-11-01 15:02:21 -04:00
# command line
2023-11-01 19:11:32 -04:00
to start Furnace at the command line, use the following command (may vary by operating system):
2023-11-01 15:02:21 -04:00
`furnace [params] [filename]`
the following parameters may be used:
- `-help`: display help.
- `-audio <engine>`: set audio engine to one of the following:
2023-11-01 19:11:32 -04:00
- `jack`: JACK Audio Connection Kit. only on Linux.
2023-11-01 15:02:21 -04:00
- `sdl`: SDL. default.
- `portaudio`: PortAudio.
2023-11-01 19:11:32 -04:00
- `-output <filename>`: export audio to `filename`.
2023-11-01 15:02:21 -04:00
- `-vgmout <filename>`: output .vgm data to `filename`.
- `-direct`: set VGM export direct stream mode.
- `-zsmout <filename>`: output .zsm data for Commander X16 Zsound.
- `-cmdout <filename>`: output command stream.
- `-binary`: set command stream output format to binary.
- `-loglevel <level>`: set the logging level to one of the following:
- `error`: critical errors only.
- `warning`: errors and warnings.
2023-11-01 19:11:32 -04:00
- `info`: errors, warnings, and useful information.
- `debug`: all of the above and information useful for debugging.
- `trace`: most verbose. includes details of inner workings. default.
2023-11-01 15:02:21 -04:00
- `-view <type>`: set visualization of data to one of the following:
- `pattern`: order and pattern.
- `commands`: commands.
- `nothing`: no visualization. default.
- `-info`: get info about a song.
- `-console`: enable console mode.
- `-loops <count>`: set number of loops. `-1` means loop forever.
- `-subsong <number>`: set sub-song.
- `-outmode one|persys|perchan`: set file output mode: all in one file, one file per chip, or one file per channel. default is `one`.
- `-safemode`: enable safe mode (software rendering without audio).
- `-safeaudio`: enable safe mode (software rendering with audio).
- `-benchmark render|seek`: run performance test.
2023-11-01 19:11:32 -04:00
- `-version`: version information.
2023-11-01 15:02:21 -04:00
- `-warranty`: view warranty disclaimer.