Skip to content

Latest commit

 

History

History
68 lines (57 loc) · 2.59 KB

mimetype.toml.md

File metadata and controls

68 lines (57 loc) · 2.59 KB

mimetype.toml

This file tells joshuto what programs to use when opening files.

There are currently 2 ways to configure opening files:

  • via extension
  • via mimetype (CURRENTLY DOES NOT WORK)

Class and inherit

To alleviate the lack of variables and programmability in TOML, 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.

Example

[class]
image_default	= [
	{ command = "qimgv", fork = true, silent = true },
	{ command = "krita", fork = true, silent = true } ]

[extension]
# inherit from image_default class
png.inherit	= "image_default"

# inherit from image_default class
jpg.inherit	= "image_default"
# in addition, also add gimp for .jpg files only
jpg.app_list	= [
	{ command = "gimp", fork = true, silent = true } ]

mkv.app_list	= [
	{ command = "mpv", args = [ "--" ] , fork = true, silent = true },
	{ command = "mediainfo", confirm_exit = true },
	{ command = "mpv", args = [ "--mute", "on", "--" ], fork = true, silent = true } ]
rs.app_list	= [
	{ command = "micro" },
	{ command = "gedit", fork = true, silent = true },
	{ command = "bat", confirm_exit = true } ]

each extension has the following fields:

  • inherit: string indicating the class to inherit from, if any
  • app_list: list of commands

each command has the following fields:

  • command: the command to run
  • args: (optional) list of arguments for the command
  • fork: tells joshuto to run the program in foreground or background
    • foreground will pause joshuto
  • silent: tells joshuto to discard all output of the program
    • useful when the program outputs debug messages into the terminal, potentially ruining joshuto's UI
  • confirm_exit: requires the user's input before going back to joshuto
    • useful when you want to read the output of the command

Explanation of the configuration above

For files with .png extension, joshuto opens them with qimgv. Joshuto suppresses all terminal output from qimgv to prevent UI disturbance. Joshuto forks qimgv so we can continue using joshuto will viewing the image. Alternatively, we can open it with krita or mediainfo via :open_with 1 and :open_with 2. With mediainfo, we want to see the output of the command before going back to joshuto, so we have confirm_exit = true

For files with .rs extension, joshuto will open it with micro, a command line text editor. In order for joshuto and micro to not conflict, joshuto will wait for micro to exit, before redrawing. Joshuto will also not suppress micro's output.