otomatalabs/furnace
7
0
Fork 0
Code Issues Pull requests Actions Packages Projects Releases Wiki Activity

Merge pull request #1570 from tildearrow/doc-commandline

Browse source 
Doc commandline
This commit is contained in:
tildearrow 2023-11-01 18:21:31 -05:00 committed by GitHub
parent cc2c64ff05 0e0b4da13b
commit 14b9ba1a56
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 43 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
doc/8-advanced/README.md
View file

@ -23,3 +23,7 @@ as listed in the "Window" menu:
- [register view](regview.md) - [register view](regview.md)
- [log viewer](log-viewer.md) - [log viewer](log-viewer.md)
- [stats](stats.md) - [stats](stats.md)
at the command line:
- [command line](commandline.md)

39
doc/8-advanced/commandline.md Normal file
View file

@ -0,0 +1,39 @@
# command line
to start Furnace at the command line, use the following command (may vary by operating system):
`furnace [params] [filename]`
the following parameters may be used:
- `-help`: display help.
- `-audio <engine>`: set audio engine to one of the following:
- `jack`: JACK Audio Connection Kit. only on Linux.
- `sdl`: SDL. default.
- `portaudio`: PortAudio.
- `-output <filename>`: export 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.
- `debug`: all of the above and information useful for debugging.
- `trace`: most verbose. includes details of inner workings. default.
- `-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`: version information.
- `-warranty`: view warranty disclaimer.