sophuwu.site > sketch
added man page
sophuwu sophie@skisiel.com
Fri, 17 Jan 2025 08:21:13 +0100
commit

1ebf5ad7596b2885c74929fb6432cda42e2c9457

parent

e23a6441935d00b59bcbb2118ff128557b7c127f

2 files changed, 66 insertions(+), 44 deletions(-)

jump to
M LICENSELICENSE

@@ -1,48 +1,21 @@

+MIT License - SK-SP License 1.0 - Version 1, July 2024 - Sophie Kisiel - Software Publication License 1.0 - https://sophuwu.site/license +Copyright (c) 2023-Present Sophie Kisiel -The SK-SP License 1.0 License defines the following terms: +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: -1. You are allowed to: - 1.1 - You can use this software. Including, but not limited to, running it, executing it, and interacting with it. - 1.2 - You can modify the software and source code. - 1.3 - You can distribute your modifications, and the original software, as long as you follow the conditions of this license. - 1.4 - You can use it for educational purposes. Including but not limited to teaching penguins programming skills. +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. -2. Under the following conditions: - 2.1 - You don't hold any creator of this software liable for any problems you encounter. - 2.a - You are aware that the creators do not provide any warranty or guarantee for this software. - 2.3 - You do not expect a high standard of quality, reliability, or security. - - 2.4 - You must not use this software for anything that would be considered illegal, unethical, or immoral. - 2.5 - You must not use this software to harm others, or to cause damage to property. - 2.6 - You agree to never attempt to weaponize penguins, or any other animal, by means of - this software. This includes, but is not limited to, launching penguins at high - velocities, or using them to deliver explosives; and any other activity that would - that would be considered illegal, unethical, or harmful to penguins. - - 2.7 - Upon request, you must provide the source code of this software. - 2.8 - You must include this license with all distributions of this software. - -3. You are not allowed to: - 3.1 - You must not remove this license from any distribution of this software. - 3.2 - By installing this software, you explicitly agree to not hold the creators of this - software liable for any problems you encounter. - 3.3 - You must not claim this software as your own. - -4. This license: - 4.1 - This license is subject to change at any time. - 4.2 - Revisions to this license might be made available at https://sophuwu.site/license - -5. Penguins: - Penguins must be respected. - Anyone who violates this license will be visited by a penguin, and will be required to engage in a - 30-minute conversation with said penguin. The penguin will express disappointment in you. - Penguins are not responsible for any damage caused by their visit. They are just penguins after all. - - -Questions about this license can be directed to sophie@sophuwu.site. -If you use this software, you agree to the terms of this license. +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE.
A docs/sketch.1

@@ -0,0 +1,49 @@

+.TH SKETCH 1 "October 2023" "Version 1.1.0" "User Commands" +.SH NAME +sketch \- Terminal image viewer + +.SH SYNOPSIS +.B sketch +[\fIoptions\fR] \fIimage_files\fR... + +.SH DESCRIPTION +.B sketch +is a terminal image viewer that scales images to fit in the terminal while maintaining the aspect ratio. + +.SH OPTIONS +.TP +.B \-h, \-\-help +Show help message and exit. + +.TP +.B \-v, \-\-version +Show version information and exit. + +.TP +.B \-n, [0\<n\<10] +Adjust the scaling of the image. Where n is between 1 and 9, for 10% and 90% scaling, respectively. Default is 100%. + +.SH EXAMPLES +.TP +View an image in the terminal: +.B sketch +image.png + +.TP +View multiple images in the terminal: +.B sketch +image1.png image2.jpg + +.TP +Adjust the scaling of the image: +.B sketch \-s 5 +image.png + +.SH AUTHOR +Sophie Kisiel <sophie@skisiel.com> + +.SH LICENSE +MIT License + +.SH SEE ALSO +.BR img (1)