diff --git a/doc/8-advanced/README.md b/doc/8-advanced/README.md index 16d83afa8..129a888c9 100644 --- a/doc/8-advanced/README.md +++ b/doc/8-advanced/README.md @@ -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) \ No newline at end of file diff --git a/doc/8-advanced/commandline.md b/doc/8-advanced/commandline.md new file mode 100644 index 000000000..6a85fc3f7 --- /dev/null +++ b/doc/8-advanced/commandline.md @@ -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 `: set audio engine to one of the following: + - `jack`: JACK Audio Connection Kit. only on Linux. + - `sdl`: SDL. default. + - `portaudio`: PortAudio. +- `-output `: export audio to `filename`. +- `-vgmout `: output .vgm data to `filename`. +- `-direct`: set VGM export direct stream mode. +- `-zsmout `: output .zsm data for Commander X16 Zsound. +- `-cmdout `: output command stream. +- `-binary`: set command stream output format to binary. +- `-loglevel `: 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 `: 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 `: set number of loops. `-1` means loop forever. +- `-subsong `: 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.