From 0e0b4da13b57a477aff94e47b1fdfc2896567944 Mon Sep 17 00:00:00 2001 From: Electric Keet Date: Wed, 1 Nov 2023 16:11:32 -0700 Subject: [PATCH] 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.