fork/wezterm

git clone https://git.julia.blue/fork/wezterm

Wez Furlongimgcat: add resize and resample functionalitye04841049

termiz-0.23.3
3.9 KiB96 linesraw
1Output an image to the terminal
2
3Usage: wezterm imgcat [OPTIONS] [FILE_NAME]
4
5Arguments:
6  [FILE_NAME]
7          The name of the image file to be displayed. If omitted, will attempt
8          to read it from stdin
9
10Options:
11      --width <WIDTH>
12          Specify the display width; defaults to "auto" which automatically
13          selects an appropriate size.  You may also use an integer value `N` to
14          specify the number of cells, or `Npx` to specify the number of pixels,
15          or `N%` to size relative to the terminal width
16
17      --height <HEIGHT>
18          Specify the display height; defaults to "auto" which automatically
19          selects an appropriate size.  You may also use an integer value `N` to
20          specify the number of cells, or `Npx` to specify the number of pixels,
21          or `N%` to size relative to the terminal height
22
23      --no-preserve-aspect-ratio
24          Do not respect the aspect ratio.  The default is to respect the aspect
25          ratio
26
27      --position <POSITION>
28          Set the cursor position prior to displaying the image. The default is
29          to use the current cursor position. Coordinates are expressed in cells
30          with 0,0 being the top left cell position
31
32      --no-move-cursor
33          Do not move the cursor after displaying the image. Note that when used
34          like this from the shell, there is a very high chance that shell
35          prompt will overwrite the image; you may wish to also use `--hold` in
36          that case
37
38      --hold
39          Wait for enter to be pressed after displaying the image
40
41      --tmux-passthru <TMUX_PASSTHRU>
42          How to manage passing the escape through to tmux
43          
44          [possible values: disable, enable, detect]
45
46      --max-pixels <MAX_PIXELS>
47          Set the maximum number of pixels per image frame. Images will be
48          scaled down so that they do not exceed this size, unless
49          `--no-resample` is also used. The default value matches the limit set
50          by wezterm. Note that resampling the image here will reduce any
51          animated images to a single frame
52          
53          [default: 25000000]
54
55      --no-resample
56          Do not resample images whose frames are larger than the max-pixels
57          value. Note that this will typically result in the image refusing to
58          display in wezterm
59
60      --resample-format <RESAMPLE_FORMAT>
61          Specify the image format to use to encode resampled/resized images.
62          The default is to match the input format, but you can choose an
63          alternative format
64          
65          [default: input]
66          [possible values: png, jpeg, input]
67
68      --resample-filter <RESAMPLE_FILTER>
69          Specify the filtering technique used when resizing/resampling images.
70          The default is a reasonable middle ground of speed and quality.
71          
72          See
73          <https://docs.rs/image/latest/image/imageops/enum.FilterType.html#examples>
74          for examples of the different techniques and their tradeoffs.
75          
76          [default: catmull-rom]
77          [possible values: nearest, triangle, catmull-rom, gaussian, lanczos3]
78
79      --resize <WIDTHxHEIGHT>
80          Pre-process the image to resize it to the specified dimensions,
81          expressed as eg: 800x600 (width x height). The resize is independent
82          of other parameters that control the image placement and dimensions in
83          the terminal; this is provided as a convenience preprocessing step.
84          
85          Resizing animated images will reduce the image to a single frame.
86          
87          The `--resample-filter` and `--resample-format` options give some
88          control over the quality of the resizing operation and the image
89          format used.
90
91      --show-resample-timing
92          When resampling or resizing, display some diagnostics around the
93          timing/performance of that operation
94
95  -h, --help
96          Print help (see a summary with '-h')