1ncplayer(1) ncplayer(1)
2
6 ncplayer - Render images and video to a terminal
7
9 ncplayer [-h] [-V] [-q] [-d delaymult] [-l loglevel] [-b blitter] [-s
10 scalemode] [-k] [-L] [-t seconds] files
11
13 ncplayer uses a multimedia-enabled Notcurses to render images and
14 videos to a terminal. By default, stretch-type scaling is used to fill
15 the rendering area, and the sex-type blitter is used (where known to
16 work well) for a 3x2→1 mapping from pixels to cells. In a terminal
17 that doesn't support Unicode 13 sextants, the quadblitter is used in‐
18 stead.
19
21 -d delaymult: Apply a non-negative rational multiplier to the de‐
22 layscale. Only applies to multiframe media such as video and animated
23 images. Not supported with -k.
24 -t seconds: Delay seconds after each file. If this option is used, the
26 "press any key to continue" prompt will not be displayed. seconds may
27 be any non-negative number.
28 -l loglevel: Log everything (high log level) or nothing (log level 0)
30 to stderr.
31 -s scalemode: Scaling mode, one of none, hires, scale, scalehi, or
33 stretch.
34 -b blitter: Blitter, one of ascii, half, quad, sex, braille, or pixel.
36 -m margins: Define rendering margins (see below).
38 -L: Loop frames until a key is pressed. Not supported with -k.
40 -k: Use direct mode (see notcurses_direct(3)). This will have the ef‐
42 fect of leaving the output on-screen after program exit, and generating
43 it inline (rather than clearing the screen and placing it at the top).
44 Not supported with -L or -d.
45 -q: Print neither frame/timing information along the top of the screen,
47 nor the output summary on exit.
48 -V: Print the program name and version, and exit with success.
50 -h: Print help information, and exit with success.
52 files: Select which files to render, and what order to render them in.
54 Default margins are all 0 and default scaling is stretch. The full
56 rendering area will thus be used. Using -m, margins can be supplied.
57 Provide a single number to set all four margins to the same value, or
58 four comma-delimited values for the top, right, bottom, and left mar‐
59 gins respectively. Negative margins are illegal.
60 Scaling mode stretch resizes the object to match the target rendering
62 area exactly. scale resizes the object so that the longer edge of the
63 rendering area is matched exactly, and the other edge is changed to
64 maintain aspect ratio. none uses the original image size.
65 Blitters can be selected by pressing '0' through '8'. NCBLIT_DEFAULT
67 corresponds to '0'. The various blitters are described in notcurs‐
68 es_visual.
69 A video can be paused with space. Press space (or any other valid con‐
71 trol) to resume.
72
74 If you're looking for a fast, inline image viewer for the shell, try
75 using ncplayer -k -t0 -q.
76 Optimal display requires a terminal advertising the rgb [22mterminfo(5) ca‐
78 pability, or that the environment variable COLORTERM is defined to
79 24bit (and that the terminal honors this variable), along with a fixed-
80 width font with good coverage of the Unicode Block Drawing Characters.
81
83 Direct mode (-k) does not yet support multiframe media. It'll read
84 them just fine, but only show the first frame. This might or might not
85 change in the future. Direct mode is kinda fundamentally suboptimal
86 for multiframe media. Until that time, -k is exclusive with -d and -L.
87
89 notcurses(3), notcurses_direct(3), notcurses_visual(3), terminfo(5),
90 unicode(7)
91
93 nick black <nickblack@linux.com>.
94 v2.2.3 ncplayer(1)