Skip to content

Commit

Permalink
Minor docs update.
Browse files Browse the repository at this point in the history
  • Loading branch information
BuvinJ committed Dec 14, 2020
1 parent 1b21740 commit eaa92ef
Showing 1 changed file with 20 additions and 13 deletions.
33 changes: 20 additions & 13 deletions docs/LowLevel.md
Original file line number Diff line number Diff line change
Expand Up @@ -216,9 +216,9 @@ there does not appear to be a way to add these to the QtIFW help! Note these di
[Silent Installer Arguments](#silent-installer-arguments).
**The following custom arguments must be passed in the format "Key=Value"**:

**outlog=[path]**: The path where you would like (custom) output details written to. The default is `<temp dir>/installer.out`.
**outlog=[path]**: The path where you would like output messages written to. The default is `<temp dir>/installer.out`.

**errlog=[path]**: The path where you would like (custom) error details written to. The default is `<temp dir>/installer.err`.
**errlog=[path]**: The path where you would like error messages written to. The default is `<temp dir>/installer.err`.

**target=[path]**: The target directory for the installation.

Expand Down Expand Up @@ -339,17 +339,24 @@ available when the installer naturally provides the option to choose this at run
here. When available, this is **disabled** by default. You must explicitly
opt to allow a reboot by including this switch.

**-o / --outfile**: The path where you would like output messages
written to. If using this, it is up to you to purge the file. An "output"
file is only produced for "notable" messages. It does not contain debug
output, nor a simple success message. Most of the time, such a file will
not be produced despite specifying this argument. It is only created to
pass back information such as a need to reboot your machine.

**-e / --errfile**: The path where you would like error details
written to. If using this, it is up to you to purge the file. The
creation of this file by the installer indicates an error occurred
(in addition to a non-zero exit code from the process).
**-o / --outfile**: Output messages from the installer are *always*
returned to the client via the stdout stream. When an outfile parameter is
provided, such messages will *additionally* be written to that path. If
using this feature, it is up to the client to purge the file. Note that an
"output" file is only produced for "notable" messages. It does not contain
verbose debugging details, nor a simple success message.
Most of the time, such a file will *not* be produced despite specifying
this argument. It is only created to pass back important information such
as a need to reboot your machine.

**-e / --errfile**: Error messages from the installer are *always* returned
to the client via the stderr stream. When an errfile parameter is
provided, such messages will *additionally* be written to that path. If
using this feature, it is up to the client to purge the file. Note that
the creation of this file by the installer indicates an error occurred.
Conversely, if the installer completed without creating this file, it
was successful. Such as also indicated via an exit code, where zero
equals success, and any non-zero is an failure.

**-d / --debug**: Enable debugging output.

Expand Down

0 comments on commit eaa92ef

Please sign in to comment.