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] [-n] [-a color] 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 7) 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 as if it were transparent.
50
51       -n: Use non-interpolative scaling.  The result is usually less pleasing
52       to the eye, but it doesn't introduce new colors.
53
54       -V: Print the program name and version, and exit with success.
55
56       -h: Print help information, and exit with success.
57
58       files: Select which files to render, and what order to render them in.
59
60       Default margins are all 0 and default scaling  is  stretch.   The  full
61       rendering  area  will thus be used.  Using -m, margins can be supplied.
62       Provide a single number to set all four margins to the same  value,  or
63       four  comma-delimited  values for the top, right, bottom, and left mar‐
64       gins respectively.  Top, right, and bottom margins are ignored when  -k
65       is used.  Negative margins are illegal.
66
67       Scaling  mode  stretch resizes the object to match the target rendering
68       area exactly.  Unless a blitter is specified with -b, stretch will  use
69       the  highest-resolution non-pixel blitter available.  scale resizes the
70       object so that the longer edge of the rendering area is matched  exact‐
71       ly,  and the other edge is changed to maintain aspect ratio.  none uses
72       the original image size.  Both scale and none aim for a 1:1 aspect  ra‐
73       tio,  and  default  to NCBLIT_2x1 at the cost of some potential resolu‐
74       tion.  The alternatives scalehi and hires  use  the  highest-resolution
75       non-pixel  blitter available.  Pixel blitting is never performed unless
76       explicitly requested with -bpixel.
77
78       Blitters can be selected  at  runtime  by  pressing  '0'  through  '6'.
79       NCBLIT_DEFAULT  corresponds to '0'.  The various blitters are described
80       in notcurses_visual(3).  If a blitter cannot be used in the current en‐
81       vironment, the current blitter will be retained.
82
83       Multiframe  media  can be paused with space.  Press space (or any other
84       valid control) to resume.
85

NOTES

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

BUGS

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

SEE ALSO

101       notcurses(3),  notcurses_direct(3),  notcurses_visual(3),  terminfo(5),
102       unicode(7)
103

AUTHORS

105       nick black <nickblack@linux.com>.
106
107
108
109                                    v2.4.9                         ncplayer(1)
Impressum