From 2e3ee3a1c370ea724f92cc684d2fde6deddd3cf7 Mon Sep 17 00:00:00 2001 From: Electric Keet Date: Wed, 1 Nov 2023 12:02:21 -0700 Subject: [PATCH 1/3] Initial command line docs. --- doc/7-systems/commandline.md | 38 ++++++++++++++++++++++++++++++++++++ doc/8-advanced/README.md | 4 ++++ 2 files changed, 42 insertions(+) create mode 100644 doc/7-systems/commandline.md diff --git a/doc/7-systems/commandline.md b/doc/7-systems/commandline.md new file mode 100644 index 000000000..074614288 --- /dev/null +++ b/doc/7-systems/commandline.md @@ -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 `: set audio engine to one of the following: + - `jack`: JACK. only on Linux. + - `sdl`: SDL. default. + - `portaudio`: PortAudio. +- `-output `: output 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. default. + - `debug`: most verbose, with all of the above and more. +- `-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`: view information about Furnace. +- `-warranty`: view warranty disclaimer. 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 From f46d2418d24fa6101e62d46d3b8e5c567823e30d Mon Sep 17 00:00:00 2001 From: Electric Keet Date: Wed, 1 Nov 2023 14:59:13 -0700 Subject: [PATCH 2/3] Moving the file back to the correct spot. How the heck... ah well, it's fixed now. --- doc/{7-systems => 8-advanced}/commandline.md | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename doc/{7-systems => 8-advanced}/commandline.md (100%) diff --git a/doc/7-systems/commandline.md b/doc/8-advanced/commandline.md similarity index 100% rename from doc/7-systems/commandline.md rename to doc/8-advanced/commandline.md From 0e0b4da13b57a477aff94e47b1fdfc2896567944 Mon Sep 17 00:00:00 2001 From: Electric Keet Date: Wed, 1 Nov 2023 16:11:32 -0700 Subject: [PATCH 3/3] More fixes to command line doc. --- doc/8-advanced/commandline.md | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/doc/8-advanced/commandline.md b/doc/8-advanced/commandline.md index 074614288..6a85fc3f7 100644 --- a/doc/8-advanced/commandline.md +++ b/doc/8-advanced/commandline.md @@ -1,6 +1,6 @@ # command line -to start furnace at the command line, use the following format: +to start Furnace at the command line, use the following command (may vary by operating system): `furnace [params] [filename]` @@ -8,10 +8,10 @@ the following parameters may be used: - `-help`: display help. - `-audio `: set audio engine to one of the following: - - `jack`: JACK. only on Linux. + - `jack`: JACK Audio Connection Kit. only on Linux. - `sdl`: SDL. default. - `portaudio`: PortAudio. -- `-output `: output audio to `filename`. +- `-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. @@ -20,8 +20,9 @@ the following parameters may be used: - `-loglevel `: 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. + - `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. @@ -34,5 +35,5 @@ the following parameters may be used: - `-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. +- `-version`: version information. - `-warranty`: view warranty disclaimer.