summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorJeff Zhao <jeff.no.zhao@gmail.com>2023-06-30 12:20:56 -0400
committerJeff Zhao <jeff.no.zhao@gmail.com>2023-06-30 12:20:56 -0400
commit93061c472d4d735ea48bb729216bb5a61fe92a64 (patch)
tree435dc26b6270e06e207f3a0d9534272cf650b816 /docs
parent2ad150c748fdf8089f304acbf7155e27a15c554e (diff)
add more documentation on fork and silent
Diffstat (limited to 'docs')
-rw-r--r--docs/configuration/mimetype.toml.md15
1 files changed, 15 insertions, 0 deletions
diff --git a/docs/configuration/mimetype.toml.md b/docs/configuration/mimetype.toml.md
index 825edf6..e69f089 100644
--- a/docs/configuration/mimetype.toml.md
+++ b/docs/configuration/mimetype.toml.md
@@ -16,6 +16,21 @@ there is a section for users to specify "classes" called `[class]`.
Here, users can specify a list of commands to open a file and inherit these
for a specific file format.
+## Silent and Fork
+
+The `silent` option will redirect any stdout and stderr output to `/dev/null`.
+This is ideal for launching GUI applications because many output debug messages to
+the terminal, disrupting Joshuto's interface.
+
+The `fork` option will launch the application in a new thread, allowing users to
+continue using Joshuto.
+
+As a rule of thumb:
+- TUI applications should almost always run without `silent` or `fork`
+- GUI applications should almost always run with the `silent` flag enabled
+ - If the user wishes to continue using joshuto while the
+ GUI application is running, enable the `fork` flag
+
## Example
```toml