1ncplayer(1)                                                        ncplayer(1)
2
3
4

NAME

6       ncplayer - Render images and video to a terminal
7

SYNOPSIS

9       ncplayer [-h] [-V]  [-q]  [-d delaymult] [-l loglevel] [-b blitter] [-s
10       scalemode] [-k] [-L] [-t seconds] [-a] files
11

DESCRIPTION

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

OPTIONS

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
25       -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
29       -l  loglevel: Log between everything (loglevel 8) and nothing (loglevel
30       0) to stderr.
31
32       -s scalemode: Scaling mode, one of  none,  hires,  scale,  scalehi,  or
33       stretch.
34
35       -b blitter: Blitter, one of ascii, half, quad, sex, braille, or pixel.
36
37       -m margins: Define rendering margins (see below).
38
39       -L: Loop frames until a key is pressed.  Not supported with -k.
40
41       -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
46       -q: Print neither frame/timing information along the top of the screen,
47       nor the output summary on exit.
48
49       -a: Treat color 0x000000 as if it were transparent.
50
51       -V: Print the program name and version, and exit with success.
52
53       -h: Print help information, and exit with success.
54
55       files: Select which files to render, and what order to render them in.
56
57       Default  margins  are  all  0 and default scaling is stretch.  The full
58       rendering area will thus be used.  Using -m, margins can  be  supplied.
59       Provide  a  single number to set all four margins to the same value, or
60       four comma-delimited values for the top, right, bottom, and  left  mar‐
61       gins  respectively.  Top, right, and bottom margins are ignored when -k
62       is used.  Negative margins are illegal.
63
64       Scaling mode stretch resizes the object to match the  target  rendering
65       area  exactly.  Unless a blitter is specified with -b, stretch will use
66       the highest-resolution non-pixel blitter available.  scale resizes  the
67       object  so that the longer edge of the rendering area is matched exact‐
68       ly, and the other edge is changed to maintain aspect ratio.  none  uses
69       the  original image size.  Both scale and none aim for a 1:1 aspect ra‐
70       tio, and default to NCBLIT_2x1 at the cost of  some  potential  resolu‐
71       tion.   The  alternatives  scalehi and hires use the highest-resolution
72       non-pixel blitter available.  Pixel blitting is never performed  unless
73       explicitly requested with -bpixel.
74
75       Blitters  can  be  selected  at  runtime  by  pressing '0' through '6'.
76       NCBLIT_DEFAULT corresponds to '0'.  The various blitters are  described
77       in notcurses_visual(3).  If a blitter cannot be used in the current en‐
78       vironment, the current blitter will be retained.
79
80       Multiframe media can be paused with space.  Press space (or  any  other
81       valid control) to resume.
82

NOTES

84       If  you're  looking  for a fast, inline image viewer for the shell, try
85       using ncplayer -k -t0 -q.
86
87       Optimal display requires a terminal advertising the rgb terminfo(5) ca‐
88       pability,  or  that  the  environment  variable COLORTERM is defined to
89       24bit (and that the terminal honors this variable), along with a fixed-
90       width font with good coverage of the Unicode Block Drawing Characters.
91

BUGS

93       Direct mode is kinda fundamentally suboptimal for multiframe media, and
94       is not yet supported with -L nor -d.  Top, right,  and  bottom  margins
95       are ignored without warning when using direct mode.
96

SEE ALSO

98       notcurses(3),  notcurses_direct(3),  notcurses_visual(3),  terminfo(5),
99       unicode(7)
100

AUTHORS

102       nick black <nickblack@linux.com>.
103
104
105
106                                    v2.3.1                         ncplayer(1)
Impressum