2020-01-14 20:50:16 +00:00
|
|
|
|
% notcurses-view(1)
|
|
|
|
|
|
% nick black <nickblack@linux.com>
|
2020-06-08 10:05:17 +00:00
|
|
|
|
% v1.5.0
|
2020-01-14 20:50:16 +00:00
|
|
|
|
|
|
|
|
|
|
# NAME
|
|
|
|
|
|
|
|
|
|
|
|
notcurses-view - Render images and video to the console
|
|
|
|
|
|
|
|
|
|
|
|
# SYNOPSIS
|
|
|
|
|
|
|
2020-04-29 07:08:21 +00:00
|
|
|
|
**notcurses-view** [**-h|--help**] [**-d delaymult**] [**-l loglevel**] [**-s scalemode**] [**-k**] files
|
2020-01-14 20:50:16 +00:00
|
|
|
|
|
|
|
|
|
|
# DESCRIPTION
|
|
|
|
|
|
|
2020-04-25 19:54:09 +00:00
|
|
|
|
**notcurses-view** uses a multimedian-enabled notcurses to render images
|
2020-01-14 20:50:16 +00:00
|
|
|
|
and videos to the terminal. Media will be scaled to the terminal's size.
|
|
|
|
|
|
|
|
|
|
|
|
# OPTIONS
|
|
|
|
|
|
|
2020-04-19 21:12:13 +00:00
|
|
|
|
**-d delaymult**: Apply a rational multiplier to the framerate.
|
2020-01-14 20:50:16 +00:00
|
|
|
|
|
|
|
|
|
|
**-l loglevel**: Log everything (high log level) or nothing (log level 0) to stderr.
|
|
|
|
|
|
|
2020-01-17 09:31:46 +00:00
|
|
|
|
**-s scalemode**: Scaling mode, one of **none**, **scale**, or **stretch**.
|
|
|
|
|
|
|
2020-04-29 07:24:11 +00:00
|
|
|
|
**-m margins**: Define rendering margins (see below).
|
|
|
|
|
|
|
2020-04-29 07:08:21 +00:00
|
|
|
|
**-k**: Inhibit use of the alternate screen. Necessary if you want the output left on your terminal after the program exits.
|
|
|
|
|
|
|
2020-01-14 20:50:16 +00:00
|
|
|
|
files: Select which files to render, and what order to render them in.
|
|
|
|
|
|
|
Fully general ncvisual layer (#647)
This represents an essentially complete rewrite of ncvisual and associated code. It had two major goals:
Improve the ncvisual API based off lessons learned, pursuant to the upcoming API freeze. In particular, I wanted to:
decouple ncvisuals from ncplanes. It should be possible to render a ncvisual to multiple planes, with different scaling each time. It should be possible to create an ncvisual without a plane, etc.
normalize the various ways of constructing an ncvisual -- file, memory, plane, etc.
Support multiple blitters, from 7-bit ASCII to Sixel. This required writing the blitters in several cases, and they're not yet in their final implementations (but the API is fine)
I have not yet unified Plots and Visuals, and might not, given that the Plot code works fine. We could at this point implement Plots in terms of Visuals, though -- the blitter backend range has been unified. Sixel is not yet implemented, though it is listed.
There is a new POC tool, blitter. It renders its arguments using all possible blitter+scaling combinations. Another new POC, resize, displays its argument, then resizes it to the screen size and displays that, explicitly making use of ncvisual_resize() rather than a scaling parameter to ncvisual_render().
This also eliminates some memory leaks and bugs we were seeing in trunk, and brings in Sixel scaffolding.
The C++ wrapper will also need patching back up; I cut most of it down while wrestling with this crap, urk.
Closes #638, #562, and #622.
2020-05-29 01:16:58 +00:00
|
|
|
|
Default margins are all 0 and default scaling is **stretch**. The full
|
|
|
|
|
|
rendering area will thus be used. Using **-m**, margins can be supplied.
|
|
|
|
|
|
Provide a single number to set all four margins to the same value, or four
|
|
|
|
|
|
comma-delimited values for the top, right, bottom, and left margins
|
|
|
|
|
|
respectively. Negative margins are illegal.
|
|
|
|
|
|
|
|
|
|
|
|
Scaling mode **stretch** resizes the object to match the target rendering
|
|
|
|
|
|
area exactly. **scale** resizes the object so that the longer edge of the
|
|
|
|
|
|
rendering area is matched exactly, and the other edge is changed to
|
|
|
|
|
|
maintain aspect ratio. **none** uses the original image size.
|
2020-04-29 07:24:11 +00:00
|
|
|
|
|
2020-06-03 20:32:27 +00:00
|
|
|
|
Blitters can be selected by pressing '0' through '8'. **NCBLIT_DEFAULT**
|
|
|
|
|
|
corresponds to '0'. The various blitters are described in
|
|
|
|
|
|
**notcurses_visual**.
|
|
|
|
|
|
|
2020-06-05 15:51:05 +00:00
|
|
|
|
A video can be paused with space. Press space (or any other valid control)
|
|
|
|
|
|
to unpause.
|
|
|
|
|
|
|
2020-01-14 20:50:16 +00:00
|
|
|
|
# NOTES
|
2020-02-12 01:46:39 +00:00
|
|
|
|
|
2020-01-14 20:50:16 +00:00
|
|
|
|
Optimal display requires a terminal advertising the **rgb** terminfo(5)
|
|
|
|
|
|
capability, or that the environment variable **COLORTERM** is defined to
|
2020-02-12 01:46:39 +00:00
|
|
|
|
**24bit** (and that the terminal honors this variable), along with a
|
|
|
|
|
|
fixed-width font with good coverage of the Unicode Block Drawing Characters.
|
2020-01-14 20:50:16 +00:00
|
|
|
|
|
|
|
|
|
|
# SEE ALSO
|
2020-02-12 01:46:39 +00:00
|
|
|
|
|
|
|
|
|
|
**notcurses(3)**,
|
2020-06-03 20:32:27 +00:00
|
|
|
|
**notcurses_visual(3)**,
|
2020-02-12 01:46:39 +00:00
|
|
|
|
**terminfo(5)**,
|
|
|
|
|
|
**unicode(7)**
|