termy-download(1)

1termy-download(1)           General Commands Manual          termy-download(1)
2
3
4

NAME

6       termy-download,  termy-imgcat,  termy-imgls  -  Display  inline content
7       within TermySequence terminals
8
9

SYNOPSIS

11       termy-download -|file...
12       termy-imgcat [-ps] [-w cells] [-h cells] -|file...
13       termy-imgls [-w cells] [-h cells] [file...]
14
15

DESCRIPTION

17       termy-download sends one or more files to  a  terminal  running  in  an
18       instance  of  termy-server(1).   The  file  data  will  be  kept in the
19       server's memory and can be downloaded by connected clients.
20
21       Note: The TermySequence protocol supports direct file downloads. For  a
22       number  of reasons, direct downloads should generally be preferred over
23       inline downloads using termy-download.  See NOTES below.
24
25       termy-imgcat sends one or more images to a terminal for inline display.
26       Command line options can be used to specify the width and height of the
27       image in character cells and whether names should be printed  with  the
28       images.   termy-imgcat  uses the ImageMagick(1) suite of tools to query
29       the format and dimensions of input images. If the image dimensions  and
30       file  size exceed hard-coded thresholds, a thumbnail image will be gen‐
31       erated and uploaded in place of the original.
32
33       termy-imgls produces a long-format directory listing with inline  image
34       thumbnails.  Command  line options can be used to specify the width and
35       height of the thumbnails in character cells. Input images are processed
36       as with termy-imgcat.
37
38

OPTIONS

40       -      Read  data  from standard input. Cannot be used with other file‐
41              name arguments.
42
43
44       -w,--width n
45              Set the image or thumbnail width to n character cells.
46
47
48       -h,--height n
49              Set the image or thumbnail height to n character cells.
50
51
52       -s,--stretch
53              Request that the image be stretched to  fit  the  display  area,
54              rather than preserving its aspect ratio.
55
56
57       -p,--print
58              Print filenames with images.
59
60
61       --help Print basic help
62
63
64       --version
65              Print version information
66
67

NOTES

69       Caution: There is a size limit on files and images uploaded using these
70       tools.
71
72       Currently this limit is 8 MiB, but since file data is  Base64  encoded,
73       the  actual  maximum size for input files is roughly 6 MB. Furthermore,
74       once uploaded, file data is kept in the server's memory until the  ter‐
75       minal  is  closed,  its  scrollback buffer is cleared, or the insertion
76       point leaves the scrollback buffer.  For these reasons,  it  is  recom‐
77       mended  that  direct  file  downloads  be  used for fetching files from
78       remote servers. Direct downloads are not subject to a  size  limitation
79       and do not consume server memory.
80
81       termy-server(1)  hashes  uploaded  files and images and only stores one
82       copy of each uploaded file. Re-displaying the same inline image  multi‐
83       ple  times in the same terminal will not consume additional server mem‐
84       ory beyond the first instance.
85
86       How inline images are displayed and which image formats  are  supported
87       is  left  up to each TermySequence client. The server simply stores the
88       data for download. Some clients may not support inline image display or
89       inline downloads. The list of supported image formats (SVG BMP GIF JPEG
90       PNG PBM PGM PPM  XBM  XPM)  coded  into  termy-imgcat  and  termy-imgls
91       reflects  the  formats  supported  by  the  qtermy(1)  client  and  the
92       ImageMagick(1) tools used for preprocessing.
93
94

NAME

SYNOPSIS

DESCRIPTION

OPTIONS

NOTES

SEE ALSO