Initial command line docs.
This commit is contained in:
parent
dc806d35b0
commit
2e3ee3a1c3
38
doc/7-systems/commandline.md
Normal file
38
doc/7-systems/commandline.md
Normal file
|
@ -0,0 +1,38 @@
|
|||
# command line
|
||||
|
||||
to start furnace at the command line, use the following format:
|
||||
|
||||
`furnace [params] [filename]`
|
||||
|
||||
the following parameters may be used:
|
||||
|
||||
- `-help`: display help.
|
||||
- `-audio <engine>`: set audio engine to one of the following:
|
||||
- `jack`: JACK. only on Linux.
|
||||
- `sdl`: SDL. default.
|
||||
- `portaudio`: PortAudio.
|
||||
- `-output <filename>`: output audio to `filename`.
|
||||
- `-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.
|
||||
- `info`: errors, warnings, and useful information. default.
|
||||
- `debug`: most verbose, with all of the above and more.
|
||||
- `-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.
|
||||
- `-version`: view information about Furnace.
|
||||
- `-warranty`: view warranty disclaimer.
|
|
@ -23,3 +23,7 @@ as listed in the "Window" menu:
|
|||
- [register view](regview.md)
|
||||
- [log viewer](log-viewer.md)
|
||||
- [stats](stats.md)
|
||||
|
||||
at the command line:
|
||||
|
||||
- [command line](commandline.md)
|
Loading…
Reference in a new issue