├── LICENSE ├── README.md ├── README.md.d ├── example1.png ├── example2.png ├── example3.png ├── example4.png └── thumb.png └── lsix /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | {one line to give the program's name and a brief idea of what it does.} 635 | Copyright (C) {year} {name of author} 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | {project} Copyright (C) {year} {fullname} 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | # lsix 4 | Like "ls", but for images. Shows thumbnails in terminal using [sixel](https://en.wikipedia.org/wiki/Sixel) 5 | graphics. 6 | 7 | 8 | ## Usage 9 | 10 | lsix [ FILES ... ] 11 | 12 | ## Examples 13 | 14 | ### Basic Usage 15 | 16 | Just typing `lsix` will show images in the current working directory. 17 | You can also specify filenames and, of course, use shell wild cards 18 | (e.g., `lsix *jpg *png`). 19 | 20 | Because lsix uses ImageMagick pretty much any image format will be 21 | supported. However, some may be slow to render (like PDF), so lsix 22 | doesn't show them unless you ask specifically. If you want to force a 23 | listing of a certain type of image simply specify the filenames or 24 | use a wildcard (`*.pdf` in the example below),. 25 | 26 | ![Example 1 of lsix usage](/README.md.d/example1.png "Most basic usage") 27 | 28 | ### Expanding GIFs 29 | If you specify a GIF (or actually any file that has multiple images in 30 | it) on the command line, all the frames will get expanded and shown in 31 | a montage. For example, `lsix nyancat.gif` shows all the frames. Note 32 | that GIF stores some frames as only the pixels that differ from the 33 | previous frame. 34 | ![Example 2 of lsix usage](/README.md.d/example2.png "GIFs get expanded") 35 | 36 | ### Terminal background color is detected 37 | 38 | You may have noticed that PNGs and SVG files have correct alpha 39 | channel for the terminal background. That is because lsix uses 40 | terminal escape sequences to try to figure out your foreground and 41 | background colors. (Foreground is used for the text fill color.) 42 | 43 | In the first example below, after running `lsix` in a white on black 44 | xterm, I sent an escape sequence to swap foreground and background 45 | colors. When I ran it again, `lsix` detected it and changed the 46 | background color to white. Of course, you can pick whatever default 47 | colors you want (e.g., `xterm -bg blue`, in the second example below). 48 | 49 | ![Example 3 of lsix usage](/README.md.d/example3.png "Reverse video works") 50 | ![Example 4 of lsix usage](/README.md.d/example4.png "Even 'xterm -bg blue' works") 51 | 52 | ## Features 53 | 54 | * Detects if your terminal can display SIXEL graphics inline using [control sequences](https://invisible-island.net/xterm/ctlseqs/ctlseqs.html#h2-Sixel-Graphics). 55 | 56 | * Works great over ssh. Perfect for manipulating those images on the 57 | web server when you can't quite remember what each one was. 58 | 59 | * Non-bitmap graphics often work fine (.svg, .eps, .pdf, .xcf). 60 | 61 | * Automatically detects if your terminal, like xterm, can increase the 62 | number of color registers to improve the image quality and does so. 63 | 64 | * Automatically detects terminal's foreground and background colors. 65 | 66 | * In terminals that support dtterm WindowOps, the number of tiles per 67 | row will adjust appropriately to the window width. 68 | 69 | * If there are many images in a directory (>21), lsix will display them 70 | one row at a time so you don't need to wait for the entire montage 71 | to be created. 72 | 73 | * If your filenames are too long, lsix will wrap the text before 74 | passing it into ImageMagick's `montage`. (Without lsix, `montage` just 75 | jumbles long filenames on top of one another.) 76 | 77 | * You can easily change things like the width of each tile in the 78 | montage, the font family, and point size by editing simple variables 79 | at the top of the file. *(Tip: try `convert -list font` to see what 80 | fonts you have on your machine.)* 81 | 82 | * Unicode filenames work fine, as long as your font has the glyphs. 83 | 84 | ## Installation 85 | 86 | Just put the [`lsix`](/lsix) file in your path (e.g., /usr/local/bin) and run 87 | it. It's just a BASH shell script. 88 | 89 | The only prerequisite software is ImageMagick. If you don't have it 90 | yet, your OS's package manager will make it easy to get. (E.g., 91 | `apt-get install imagemagick`). 92 | 93 | MacOS users may prefer to install lsix using `brew install lsix` which 94 | installs ImageMagick, if necessary. 95 | 96 | ## Your Terminal must support Sixel graphics 97 | 98 | I developed this using [xterm](https://invisible-island.net/xterm/) in 99 | vt340 emulation mode, but I believe this should work on 100 | any Sixel compatible terminal. You may test your terminal by viewing a 101 | single image, like so: 102 | 103 | convert foo.jpg -geometry 800x480 sixel:- 104 | 105 | ### XTerm 106 | 107 | Note that xterm does not have Sixel mode enabled by default, so you 108 | need to either run it like so: 109 | 110 | xterm -ti vt340 111 | 112 | Or, make vt340 the default terminal type for xterm. Add the following 113 | to your `.Xresources` file and run `xrdb -merge .Xresources`. 114 | 115 | ! Allow sixel graphics. (Try: "convert -colors 16 foo.jpg sixel:-"). 116 | xterm*decTerminalID : vt340 117 | 118 | Further, some distributions, such as Fedora, appear to not compile `xterm` 119 | with sixel support. In that case, try an alternate terminal, such as 120 | `foot` or `mlterm`. 121 | 122 | ### SIXEL compatible terminals 123 | 124 | * XTerm (tested) 125 | * MLterm (tested) 126 | * foot (tested) 127 | * Wezterm (tested) 128 | * Contour (tested) 129 | * iTerm2 for Apple MacOS (tested) 130 | * Konsole (reported) 131 | * yakuake (reported) 132 | * WSLtty for Microsoft Windows (reported) 133 | * MinTTY for Cygwin (Microsoft Windows) (reported) 134 | * Yaft for Linux framebuffer (tested) 135 | * VTE (special compilation, reported) 136 | * sixel-tmux (fork of tmux, reported) 137 | * ttyd (reported) 138 | 139 | ### SIXEL incompatible terminals 140 | 141 | * MacOS Terminal, kitty 142 | * All standard libvte based terminals 143 | * gnome-terminal 144 | * terminator 145 | * lxterm 146 | * Alacritty (might work with [a patch](https://github.com/alacritty/alacritty/pull/4763)) 147 | 148 | ## Configuration 149 | 150 | Because `lsix` is currently designed to be very simple, there are no 151 | command line flags, no configuration files, no knobs to twiddle, or 152 | frobs to frobnosticate. However, since the script is so simple, if you 153 | want to make a change, it's pretty easy to do just by editing the 154 | file. Everything is nicely commented with the most common default 155 | variables at the top. 156 | 157 | ## Contact the author 158 | 159 | I welcome feedback. If you use lsix and like it or have suggestions 160 | for how it can be improved, please go ahead and send your thoughts to 161 | me [@hackerb9](https://github.com/hackerb9/lsix/issues/new) via 162 | GitHub. 163 | 164 | 165 | ## Bugs 166 | 167 | * XTerm's reverse video mode (`xterm -rv`) is different from 168 | specifying the foreground and background explicitly. There is a way 169 | to detect the latter, but not the former. That means the background 170 | color will be incorrect for folks who use XTerm's reverseVideo 171 | resource. (See issue #20). 172 | 173 | * XTerm's screen width is currently limited to 1000px due to a 174 | misfeature which causes it to silently show nothing. This limitation 175 | will be removed once xterm can handle images greater than 1000x1000. 176 | [Last tested with XTerm(344)]. 177 | 178 | * Filenames that begin with "@" are special to ImageMagick and it'll 179 | freak out if you don't prepend a directory. (`lsix ./@foo.png`) 180 | (This is a bug in ImageMagick, not lsix). 181 | 182 | * Specifying the empty string `""` as a filename makes ImageMagick hang. 183 | (This appears to be an ImageMagick bug / misfeature). 184 | 185 | * Long filenames are wrapped, but not intelligently. Would it 186 | complicate this script too much to make it prefer to wrap on whites 187 | space, dashes, underscores, and periods? Maybe. 188 | 189 | * Directories specified on the command line are processed as if the 190 | user had cd'd to that directory. It wouldn't be hard to implement 191 | recursion, but is there actually a need? I'm reluctant to complicate 192 | such a simple script with command line flags. 193 | 194 | * If you run `lsix foo.avi`, you're asking for trouble. 195 | 196 | 197 | ## Future Issues 198 | 199 | * The Sixel standard doesn't appear to have a way to query the size of 200 | the graphics screen. Reading the VT340 documentation, it appears 201 | your program has to already know the resolution of the device you're 202 | rendering on. 203 | 204 | XTerm, as of version 344, has added [a control 205 | sequence](https://invisible-island.net/xterm/ctlseqs/ctlseqs.html#h2-Functions-using-CSI-_-ordered-by-the-final-character_s_) 206 | that solves the problem — `CSI ? Pi ; Pa ; Pv S` — but some 207 | terminals, for example `mlterm`, haven't yet implemented it. 208 | 209 | There is an alternate way to read the window size using the dtterm 210 | WindowOps extension but it is not quite the right solution as the 211 | geometry of the Sixel graphics screen is not necessarily the same as 212 | the window size. (For example, xterm limits the graphics geometry to 213 | 1000x1000, even though the window can actually be larger.) To help 214 | with terminals such as mlterm, `lsix` will use the dtterm WindowOps 215 | as a fallback. 216 | 217 | If neither solution works, `lsix` will assume you are on a VT340 218 | (800x480) and can fit only 6 tiles per row. 219 | 220 | * The Sixel standard also lacks a way to query the number of 221 | color registers available. I used the extensions from `xterm` to do 222 | so, but I do not know how widely implemented they are. If a terminal 223 | does not respond, `lsix` presumes you're on an original vt340 and 224 | uses only 16 color registers. (Sorry, 4-gray vt330 users! Time to 225 | upgrade. ;-) ) 226 | 227 | 228 | * The [Kermit project](https://kermitproject.org/) created a MS-DOS 229 | terminal emulator that was popular in the late 1980s/early 1990s. 230 | Its sixel implementation is not compatible with lsix because it 231 | shows the graphics on a screen separate from the text. However, I 232 | noticed one feature in its documentation: an escape sequence to 233 | request the current graphics window size and number of colors: 234 | 235 | ``` 236 | ESC [ ? 256 n Request screen size report 237 | 238 | Report is ESC [ ? 256; Ph; Pw; Pc n for graphics systems 239 | 240 | where Ph is screen height in dots 241 | Pw is screen width in dots 242 | Pc is number of colors (0, 1 or 16, for none, b/w, ega/vga) 243 | 244 | Report is ESC [ ? 24; 80; 0 n for pure text mono systems. 245 | ``` 246 | 247 | Did any other terminal emulators ever use the sequence? Would it be 248 | worthwhile to add to `lsix`? 249 | 250 | * [libsixel](https://github.com/saitoha/libsixel) is an excellent 251 | project for writing programs that can output optimized Sixel 252 | graphics commands. Because I have a lot of respect for the project, 253 | I feel I should explain why `lsix` does not use libsixel. 254 | 255 | * (a) I wanted lsix to work everywhere easily. Bash and imagemagick 256 | are ubiquitous, so a shell script is a natural solution. 257 | 258 | * (b) I wanted `lsix` to be simple enough that it could be easily 259 | customized and extended by other people. (Including myself.) 260 | 261 | * (c) ImageMagick has better support for reading different formats 262 | than stb_image (the library used by libsixel's `img2sixel`). (For 263 | example: xpm, svg, 16-bit png, and even sixel files are not 264 | recognized by img2sixel). Since ImageMagick can read all of those 265 | and write sixel output directly, it made sense to use it for both. 266 | 267 | * (d) While libsixel is optimized and would surely be faster than 268 | ImageMagick, it's overkill. For a simple directory listing, this 269 | is plenty fast enough. 270 | 271 | ## Resources 272 | 273 | * [XTerm Control Sequences](https://invisible-island.net/xterm/ctlseqs/ctlseqs.html) 274 | * [ImageMagick](https://imagemagick.org/) 275 | * [VT340 Programmer's Reference](https://vt100.net/docs/vt3xx-gp/): 276 | * [Chapter 14](https://vt100.net/docs/vt3xx-gp/chapter14.html). Sixel Graphics. 277 | * [Chapter 16](https://vt100.net/docs/vt3xx-gp/chapter16.html#S16.3) Difference between Level 1 and Level 2 Sixel implementations. 278 | 279 | _Nota bene: this reference has the sense for DECSDM (sixel 280 | display mode) reversed! The actual behaviour of the VT340 is 281 | that when DECSDM is reset (the default), sixel scrolling is enabled. 282 | This can be done by sending _`Esc[?80l`_, but lsix does not do 283 | so as it would break many current terminal emulators. 284 | See issue #41 for details._ 285 | 286 | * [DEC STD 070 Video Systems Reference Manual](https://archive.org/details/bitsavers_decstandar0VideoSystemsReferenceManualDec91_74264381). 287 | A weighty tome which covers nearly everything in exacting detail. I referred mostly to sections 4 (escape sequences) and 9 (sixel programming). 288 | 289 | * [VT340 Test](https://github.com/hackerb9/vt340test), a project to document the actual behaviour of the DEC VT340 hardware. 290 | 291 | * [Digital ANSI-Compliant Printing Protocol: Level 2 Programming Reference Manual](http://www.vaxhaven.com/images/f/f7/EK-PPLV2-PM-B01.pdf), Chapter 5: Sixel Graphics. An excellent and reasonably clear discussion for anyone who wants to generate or parse sixel graphics. 292 | -------------------------------------------------------------------------------- /README.md.d/example1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/hackerb9/lsix/93d067a56421e5a5605c0b11814d694fed0a0397/README.md.d/example1.png -------------------------------------------------------------------------------- /README.md.d/example2.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/hackerb9/lsix/93d067a56421e5a5605c0b11814d694fed0a0397/README.md.d/example2.png -------------------------------------------------------------------------------- /README.md.d/example3.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/hackerb9/lsix/93d067a56421e5a5605c0b11814d694fed0a0397/README.md.d/example3.png -------------------------------------------------------------------------------- /README.md.d/example4.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/hackerb9/lsix/93d067a56421e5a5605c0b11814d694fed0a0397/README.md.d/example4.png -------------------------------------------------------------------------------- /README.md.d/thumb.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/hackerb9/lsix/93d067a56421e5a5605c0b11814d694fed0a0397/README.md.d/thumb.png -------------------------------------------------------------------------------- /lsix: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bash 2 | 3 | # lsix: like ls, but for images. 4 | # Shows thumbnails of images with titles directly in terminal. 5 | 6 | # Requirements: just ImageMagick (and a Sixel terminal, of course) 7 | 8 | # Version 1.9.1 9 | # B9 June 2024 10 | 11 | # See end of file for USAGE. 12 | 13 | 14 | # The following defaults may be overridden if autodetection succeeds. 15 | numcolors=16 # Default number of colors in the palette. 16 | background=white # Default montage background. 17 | foreground=black # Default text color. 18 | width=800 # Default width of screen in pixels. 19 | 20 | # Feel free to edit these defaults to your liking. 21 | tilesize=120 # Width and height of each tile in the montage. 22 | tilewidth=$tilesize # (or specify separately, if you prefer) 23 | tileheight=$tilesize 24 | 25 | # If you get questionmarks for Unicode filenames, try using a different font. 26 | # You can list fonts available using `convert -list font`. 27 | #fontfamily=Droid-Sans-Fallback # Great Asian font coverage 28 | #fontfamily=Dejavu-Sans # Wide coverage, comes with GNU/Linux 29 | #fontfamily=Mincho # Wide coverage, comes with MS Windows 30 | 31 | # Default font size is based on width of each tile in montage. 32 | fontsize=$((tilewidth/10)) 33 | #fontsize=16 # (or set the point size directly, if you prefer) 34 | 35 | timeout=0.25 # How long to wait for terminal to respond 36 | # to a control sequence (in seconds). 37 | 38 | # Sanity checks and compatibility 39 | if [[ ${BASH_VERSINFO[0]} -eq 3 ]]; then 40 | if bash --version | head -1 | grep -q "version 3"; then 41 | cat <<-EOF >&2 42 | Error: The version of Bash is extremely out of date. 43 | (2007, the same year Steve Jobs announced the iPhone!) 44 | 45 | This is almost always due to Apple's MacOS being silly. 46 | Please let Apple know that their users expect current UNIX tools. 47 | 48 | In the meantime, try using "brew install bash". 49 | EOF 50 | exit 1 51 | else 52 | exec bash "$0" "$@" || echo "Exec failed" >&2 53 | exit 1 54 | fi 55 | fi 56 | 57 | shopt -s expand_aliases # Allow aliases for working around quirks. 58 | 59 | # For ImageMagick 6 <-> 7 compatibility. 60 | if type magick &>/dev/null; then 61 | alias convert='magick' 62 | alias montage='magick montage' 63 | fi 64 | 65 | if ! command -v magick montage &>/dev/null; then # (implicit 'or') 66 | echo "Please install ImageMagick" >&2 67 | exit 1 68 | fi 69 | 70 | if type gsed &>/dev/null; then 71 | alias sed=gsed # Use GNU sed for MacOS & BSD. 72 | fi 73 | 74 | cleanup() { 75 | echo -n $'\e\\' # Escape sequence to stop SIXEL. 76 | stty echo # Reset terminal to show characters. 77 | exit 0 78 | } 79 | trap cleanup SIGINT SIGHUP SIGABRT EXIT 80 | 81 | autodetect() { 82 | # Various terminal automatic configuration routines. 83 | 84 | # Don't show escape sequences the terminal doesn't understand. 85 | stty -echo # Hush-a Mandara Ni Pari 86 | 87 | # IS TERMINAL SIXEL CAPABLE? # Send Device Attributes 88 | IFS=";?c" read -a REPLY -s -t 1 -d "c" -p $'\e[c' >&2 89 | for code in "${REPLY[@]}"; do 90 | if [[ $code == "4" ]]; then 91 | hassixel=yup 92 | break 93 | fi 94 | done 95 | 96 | # YAFT is vt102 compatible, cannot respond to vt220 escape sequence. 97 | if [[ "$TERM" == yaft* ]]; then hassixel=yeah; fi 98 | 99 | if [[ -z "$hassixel" && -z "$LSIX_FORCE_SIXEL_SUPPORT" ]]; then 100 | cat <<-EOF >&2 101 | Error: Your terminal does not report having sixel graphics support. 102 | 103 | Please use a sixel capable terminal, such as xterm -ti vt340, or 104 | ask your terminal manufacturer to add sixel support. 105 | 106 | You may test your terminal by viewing a single image, like so: 107 | 108 | convert foo.jpg -geometry 800x480 sixel:- 109 | 110 | If your terminal actually does support sixel, please file a bug 111 | report at http://github.com/hackerb9/lsix/issues 112 | EOF 113 | read -s -t 1 -d "c" -p $'\e[c' >&2 114 | if [[ "$REPLY" ]]; then 115 | echo 116 | cat -v <<< "Please mention device attribute codes: ${REPLY}c" 117 | fi 118 | 119 | exit 1 120 | fi 121 | 122 | # SIXEL SCROLLING (~DECSDM) is now presumed to be enabled. 123 | # See https://github.com/hackerb9/lsix/issues/41 for details. 124 | 125 | # TERMINAL COLOR AUTODETECTION. 126 | # Find out how many color registers the terminal has 127 | IFS=";" read -a REPLY -s -t ${timeout} -d "S" -p $'\e[?1;1;0S' >&2 128 | [[ ${REPLY[1]} == "0" ]] && numcolors=${REPLY[2]} 129 | 130 | # YAFT is vt102 compatible, cannot respond to vt220 escape sequence. 131 | if [[ "$TERM" == yaft* ]]; then numcolors=256; fi 132 | 133 | # Increase colors, if needed 134 | if [[ $numcolors -lt 256 ]]; then 135 | # Attempt to set the number of colors to 256. 136 | # This will work for xterm, but fail on a real vt340. 137 | IFS=";" read -a REPLY -s -t ${timeout} -d "S" -p $'\e[?1;3;256S' >&2 138 | [[ ${REPLY[1]} == "0" ]] && numcolors=${REPLY[2]} 139 | fi 140 | 141 | # Query the terminal background and foreground colors. 142 | IFS=";:/" read -a REPLY -r -s -t ${timeout} -d "\\" -p $'\e]11;?\e\\' >&2 143 | if [[ ${REPLY[1]} =~ ^rgb ]]; then 144 | # Return value format: $'\e]11;rgb:ffff/0000/ffff\e\\'. 145 | # ImageMagick wants colors formatted as #ffff0000ffff. 146 | background='#'${REPLY[2]}${REPLY[3]}${REPLY[4]%%$'\e'*} 147 | IFS=";:/" read -a REPLY -r -s -t ${timeout} -d "\\" -p $'\e]10;?\e\\' >&2 148 | if [[ ${REPLY[1]} =~ ^rgb ]]; then 149 | foreground='#'${REPLY[2]}${REPLY[3]}${REPLY[4]%%$'\e'*} 150 | # Check for "Reverse Video" (DECSCNM screen mode). 151 | IFS=";?$" read -a REPLY -s -t ${timeout} -d "y" -p $'\e[?5$p' 152 | if [[ ${REPLY[2]} == 1 || ${REPLY[2]} == 3 ]]; then 153 | temp=$foreground 154 | foreground=$background 155 | background=$temp 156 | fi 157 | fi 158 | fi 159 | # YAFT is vt102 compatible, cannot respond to vt220 escape sequence. 160 | if [[ "$TERM" == yaft* ]]; then background=black; foreground=white; fi 161 | 162 | # Send control sequence to query the sixel graphics geometry to 163 | # find out how large of a sixel image can be shown. 164 | IFS=";" read -a REPLY -s -t ${timeout} -d "S" -p $'\e[?2;1;0S' >&2 165 | if [[ ${REPLY[2]} -gt 0 ]]; then 166 | width=${REPLY[2]} 167 | else 168 | # Nope. Fall back to dtterm WindowOps to approximate sixel geometry. 169 | IFS=";" read -a REPLY -s -t ${timeout} -d "t" -p $'\e[14t' >&2 170 | if [[ $? == 0 && ${REPLY[2]} -gt 0 ]]; then 171 | width=${REPLY[2]} 172 | fi 173 | fi 174 | 175 | # BUG WORKAROUND: XTerm cannot show images wider than 1000px. 176 | # Remove this hack once XTerm gets fixed. Last checked: XTerm(344) 177 | if [[ $TERM =~ xterm && $width -ge 1000 ]]; then width=1000; fi 178 | 179 | # Space on either side of each tile is less than 0.5% of total screen width 180 | tilexspace=$((width/201)) 181 | tileyspace=$((tilexspace/2)) 182 | # Figure out how many tiles we can fit per row. ("+ 1" is for -shadow). 183 | numtiles=$((width/(tilewidth + 2*tilexspace + 1))) 184 | } 185 | 186 | main() { 187 | # Discover and setup the terminal 188 | autodetect 189 | 190 | if [[ $# == 0 ]]; then 191 | # No command line args? Use a sorted list of image files in CWD. 192 | shopt -s nullglob nocaseglob nocasematch 193 | set -- *{jpg,jpeg,png,gif,webp,tiff,tif,p?m,x[pb]m,bmp,ico,svg,eps} 194 | [[ $# != 0 ]] || exit 195 | readarray -t < <(printf "%s\n" "$@" | sort) 196 | 197 | # Only show first frame of animated GIFs if filename not specified. 198 | for x in ${!MAPFILE[@]}; do 199 | if [[ ${MAPFILE[$x]} =~ (gif|webp)$ ]]; then 200 | MAPFILE[$x]="${MAPFILE[$x]}[0]" 201 | fi 202 | done 203 | set -- "${MAPFILE[@]}" 204 | else 205 | # Command line args specified. Check for directories. 206 | lsix=$(realpath "$0") 207 | for arg; do 208 | if [ -d "$arg" ]; then 209 | echo Recursing on $arg 210 | (cd "$arg"; $lsix) 211 | else 212 | nodirs+=("$arg") 213 | fi 214 | done 215 | set -- "${nodirs[@]}" 216 | fi 217 | 218 | 219 | # Resize on load: Save memory by appending this suffix to every filename. 220 | resize="[${tilewidth}x${tileheight}]" 221 | 222 | imoptions="-tile ${numtiles}x1" # Each montage is 1 row x $numtiles columns 223 | imoptions+=" -geometry ${tilewidth}x${tileheight}>+${tilexspace}+${tileyspace}" # Size of each tile and spacing 224 | imoptions+=" -background $background -fill $foreground" # Use terminal's colors 225 | imoptions+=" -auto-orient " # Properly rotate JPEGs from cameras 226 | if [[ $numcolors -gt 16 ]]; then 227 | imoptions+=" -shadow " # Just for fun :-) 228 | fi 229 | 230 | # See top of this file to change fontfamily and fontsize. 231 | [[ "$fontfamily" ]] && imoptions+=" -font $fontfamily " 232 | [[ "$fontsize" ]] && imoptions+=" -pointsize $fontsize " 233 | 234 | # Create and display montages one row at a time. 235 | while [ $# -gt 0 ]; do 236 | # While we still have images to process... 237 | onerow=() 238 | goal=$(($# - numtiles)) # How many tiles left after this row 239 | while [ $# -gt 0 -a $# -gt $goal ]; do 240 | len=${#onerow[@]} 241 | onerow[len++]="-label" 242 | onerow[len++]=$(processlabel "$1") 243 | onerow[len++]="file://$1" 244 | shift 245 | done 246 | montage "${onerow[@]}" $imoptions gif:- \ 247 | | convert - -colors $numcolors sixel:- 248 | done 249 | } 250 | 251 | processlabel() { 252 | # This routine is mostly to appease ImageMagick. 253 | # 1. Remove silly [0] suffix and : prefix. 254 | # 2. Quote percent backslash, and at sign. 255 | # 3. Replace control characters with question marks. 256 | # 4. If a filename is too long, remove extension (.jpg). 257 | # 5. Split long filenames with newlines (recursively) 258 | span=15 # filenames longer than span will be split 259 | echo -n "$1" | 260 | sed 's|^:||; s|\[0]$||;' | tr '[:cntrl:]' '?' | 261 | awk -v span=$span -v ORS="" ' 262 | function halve(s, l,h) { # l and h are locals 263 | l=length(s); h=int(l/2); 264 | if (l <= span) { return s; } 265 | return halve(substr(s, 1, h)) "\n" halve(substr(s, h+1)); 266 | } 267 | { 268 | if ( length($0) > span ) gsub(/\..?.?.?.?$/, ""); 269 | print halve($0); 270 | } 271 | ' | 272 | sed 's|%|%%|g; s|\\|\\\\|g; s|@|\\@|g;' 273 | } 274 | 275 | #### 276 | 277 | main "$@" 278 | 279 | # Send an escape sequence and wait for a response from the terminal 280 | # so that the program won't quit until images have finished transferring. 281 | read -s -t 60 -d "c" -p $'\e[c' >&2 282 | 283 | 284 | ###################################################################### 285 | # NOTES: 286 | 287 | # Usage: lsix [ FILES ... ] 288 | 289 | # * FILES can be any image file that ImageMagick can handle. 290 | # 291 | # * If no FILES are specified the most common file extensions are tried. 292 | # (For now, lsix only searches the current working directory.) 293 | # 294 | # * Non-bitmap graphics often work fine (.svg, .eps, .pdf, .xcf). 295 | # 296 | # * Files containing multiple images (e.g., animated GIFs) will show 297 | # all the images if the filename is specified at the command line. 298 | # Only the first frame will be shown if "lsix" is called with no 299 | # arguments. 300 | # 301 | # * Because this uses escape sequences, it works seamlessly through ssh. 302 | # 303 | # * If your terminal supports reporting the background and foreground 304 | # color, lsix will use those for the montage background and text fill. 305 | # 306 | # * If your terminal supports changing the number of color registers 307 | # to improve the picture quality, lsix will do so. 308 | 309 | # * Only software needed is ImageMagick (e.g., apt install imagemagick). 310 | 311 | # Your terminal must support SIXEL graphics. E.g., 312 | # 313 | # xterm -ti vt340 314 | 315 | # * To make vt340 be the default xterm type, set this in .Xresources: 316 | # 317 | # ! Allow sixel graphics. (Try: "convert -colors 16 foo.jpg sixel:-"). 318 | # xterm*decTerminalID : vt340 319 | 320 | # * Be cautious using lsix on videos (lsix *.avi) as ImageMagick will 321 | # try to make a montage of every single frame and likely exhaust 322 | # your memory and/or your patience. 323 | 324 | # BUGS 325 | 326 | # * Some transparent images (many .eps files) presume a white background 327 | # and will not show up if your terminal's background is black. 328 | # * This file is getting awfully long for a one line kludge. :-) 329 | 330 | # LICENSE INFORMATION 331 | # (AKA, You know your kludge has gotten out of hand when...) 332 | 333 | # Dual license: 334 | # * You have all the freedoms permitted to you under the 335 | # GNU GPL >=3. (See the included LICENSE file). 336 | 337 | # * Additionally, this program can be used under the terms of whatever 338 | # license 'xterm' is using (now or in the future). This is primarily 339 | # so that, if the xterm maintainer (currently Thomas E. Dickey) so 340 | # wishes, this program may be included with xterm as a Sixel test. 341 | # However, anyone who wishes to take advantage of this is free to do so. 342 | --------------------------------------------------------------------------------