MENYOKI.CONF(5) menyoki manual MENYOKI.CONF(5)

menyoki.conf - menyoki configuration file

$MENYOKI_CONFIG, $HOME/.config/menyoki.conf, $HOME/.config/menyoki/menyoki.conf, $HOME/.config/menyoki/config

It’s possible to override the default command line arguments with a configuration file. It can be specified via --config option or $MENYOKI_CONFIG environment variable. Also, it can be placed to a location where menyoki looks for as default.

Options that belong to the [general] section.

Increase logging verbosity
Do not show output
Set the main color [default: 3AA431]

Options that belong to the [record] section.

Record the root window
Record the focused window
Select the window to record
Record the parent of the window
Record with the alpha channel
Disable the action keys while recording
Select the window with mouse click
Set the action keys [default: LAlt-S,LAlt-Enter]
Set the cancel keys [default: LControl-D,Escape]
Set the border width [default: 1]
Set the record area padding
Set the record area size
Set the duration for recording [default: ∞]
Set the countdown before recording [default: 3]
Set the timeout for window selection [default: 300]
Set the refresh interval for window selection [default: 10]
Set the font to use for window selection
Set the monitor to record as root window
Set the command to run

Options that belong to the [split] section.

Set the output directory
Set the animation file

Options that belong to the [make] section.

Use frames in the order given
Set the FPS [default: 20]
Set the frame quality (1-100) [default: 75]
Set the number of repetitions [default: ∞]
Set the directory to read frames
Set the animation format [default: gif] [possible values: gif, apng]

Options that belong to the [capture] section.

Capture the root window
Capture the focused window
Select the window to capture
Capture the parent of the window
Capture with the alpha channel
Select the window with mouse click
Set the action keys [default: LAlt-S,LAlt-Enter]
Set the cancel keys [default: LControl-D,Escape]
Set the border width [default: 1]
Set the capture area padding
Set the capture area size
Set the countdown before capturing [default: 0]
Set the timeout for window selection [default: 300]
Set the refresh interval for window selection [default: 10]
Set the font to use for window selection
Set the monitor to capture as root window
Set the command to run

Options that belong to the [edit] section.

Convert image using the given encoder
Convert image to grayscale
Invert the colors of the image
Apply padding to crop the image
Resize the image without keeping the aspect ratio
Resize the image proportionally by aspect ratio [default: 1.0]
Rotate the image (clockwise) [possible values: 90, 180, 270]
Flip the image [possible values: horizontal, vertical]
Blur the image [default: 0.0]
Adjust the hue of the image [default: ±0]
Adjust the contrast of the image [default: ±0.0]
Adjust the brightness of the image [default: ±0]
Set the sampling filter for scaling [default: lanczos3] [possible values: nearest, triangle, catmull-rom, gaussian, lanczos3]
Set the input file

Options that belong to the [analyze] section.

Use Unix timestamp for report dates
Set the time zone of the report [default: utc] [possible values: utc, local]
Set the image file

Options that belong to the [view] section.

Display transparent image with transparent background
Set the image file

Options that belong to the [save] section.

Always save the file with an extension
Add Unix timestamp to the file name
Add formatted date/time to the file name [default: %Y%m%dT%H%M%S]
Set the output file

Options that belong to the [gif] section.

Use the gifski encoder
Encode 3 times faster (gifski)
Set the FPS [default: 20]
Set the frame quality (1-100) [default: 75]
Set the number of repetitions [default: ∞]
Set the animation speed [default: 1.0]
Cut the beginning of the animation [default: 0.0]
Cut the end of the anim [default: 0.0]

Options that belong to the [apng] section.

Set the FPS [default: 20]
Set the number of repetitions [default: ∞]
Set the animation speed [default: 1.0]
Cut the beginning of the animation [default: 0.0]
Cut the end of the anim [default: 0.0]

Options that belong to the [png] section.

Set the compression level [default: fast] [possible values: default, fast, best]
Set the filter algorithm [default: sub] [possible values: none, sub, up, avg, paeth]

Options that belong to the [jpg] section.

Set the image quality (1-100) [default: 90]

Options that belong to the [webp] section.

Set the lossy encoding quality (1-100) [default: 80]
Use lossless encoding

Options that belong to the [pnm] section.

Set the PNM format [default: pixmap] [possible values: bitmap, graymap, pixmap, arbitrary]
Set the encoding for storing the samples [default: binary] [possible values: binary, ascii]

Corresponding environment variables can be set for overriding the command line flags and options. The general prototype of the variables that menyoki checks are the following:

MENYOKI_{SECTION}_{ARGUMENT}=value

Command Environment Variables
menyoki --quiet MENYOKI_GENERAL_QUIET=true
menyoki record gif --fps 10 save --timestamp MENYOKI_GIF_FPS=10 MENYOKI_SAVE_TIMESTAMP=true
menyoki capture --size 200x300 jpg --quality 100 MENYOKI_CAPTURE_SIZE=200x300 MENYOKI_JPG_QUALITY=100
menyoki edit test.png --ratio 2.0 --filter triangle MENYOKI_EDIT_RATIO=2.0 MENYOKI_EDIT_FILTER=triangle
menyoki split test.gif --dir frames/ pnm --format graymap MENYOKI_SPLIT_DIR=frames/ MENYOKI_PNM_FORMAT=graymap
menyoki analyze test.png --timestamp save --date %H%M%S MENYOKI_ANALYZE_TIMESTAMP=true MENYOKI_SAVE_DATE=%H%M%S
menyoki view test.png --transparent MENYOKI_VIEW_TRANSPARENT=true

Written by Orhun Parmaksız <orhunparmaksiz@gmail.com>

Contact the author via email or use GitHub Issues for reporting bugs: https://github.com/orhun/menyoki/issues/

Copyright © 2020-2023 Orhun Parmaksız

Licensed under GPLv3: https://gnu.org/licenses/gpl.html

menyoki(1)

See the project homepage at https://github.com/orhun/menyoki for full documentation.

March 2023 menyoki 1.7.0