Skip to content

Commit

Permalink
Update man page outputs for makew0rld#3
Browse files Browse the repository at this point in the history
  • Loading branch information
makew0rld committed May 1, 2021
1 parent b4bbf68 commit 332664d
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 26 deletions.
22 changes: 10 additions & 12 deletions MANPAGE.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,17 +8,17 @@ date: DATE
---

# NAME
didder - dither images
didder dither images

# SYNOPSIS
**didder** \[global options] command [command options] [arguments...]

# DESCRIPTION
Dither images with a variety of algorithms and processing options.

Mandatory global flags are **\--palette**, **\--in**, and **\--out**, all others are optional. Each command represents a dithering algorithm or set of algorithms to apply to the input image(s).
Mandatory global flags are **\--palette**, **\--in**, and **\--out**, all others are optional. Each command applies a dithering algorithm or set of algorithms to the input image(s).

The most important section in this manual is the **TIPS** one. Make sure you check it out.
The most important parts of this manual are highlighted in the **TIPS** section, make sure you check it out!

Homepage: <https://github.com/makeworld-the-better-one/didder>

Expand Down Expand Up @@ -105,7 +105,7 @@ Set frames per second for animated GIF output. Note that not all FPS values can

**-l**, **\--loop** *NUM*

Set the number of times animated GIF output should loop. 0 is the default, and means infinite looping.
Set the number of times animated GIF output should loop. 0 is the default, and will loop infinitely.

**-x**, **\--width** *NUM*

Expand Down Expand Up @@ -228,25 +228,23 @@ Read about **\--recolor** if you haven't already.

It's easy to mess up a dithered image by scaling it manually. It's best to scale the image to the size you want before dithering (externally, or with **\--width** and/or **\--height**), and then leave it.

If you need to scale it up afterward, use **\--upscale**, rather than another tool. This will prevent image artifacts or blurring.
If you need to scale it up afterward, use **\--upscale**, rather than another tool. This will prevent image artifacts and blurring.

Be wary of environments where you can't make sure an image will be displayed at 100% size, pixel for pixel. Make sure nearest-neighbor scaling is being used at least.
Be wary of environments where you can't make sure an image will be displayed at 100% size, pixel for pixel. Make sure to at least use nearest-neighbor scaling, do your best to preserve sharp pixel edges.

Dithered images must only be encoded in a lossless image format. This is why the tool only outputs PNG or GIF.
Dithered images must only be encoded in a lossless image format. This is why the tool only outputs PNG and GIF.

To increase the dithering artifacts for aesthetic effect, you can downscale the image before dithering and upscale after. Like if the image is 1000 pixels tall, your command can look like **didder --height 500 --upscale 2 [...]**. Depending on the input image size and what final size you want, you can of course just upscale as well.

If your palette (original or recolor) is low-spread, meaning it doesn't span much of the available shades of a single hue or the entire RGB space, you can use flags like **\--brightness**, **\--contrast**, and **\--saturation** to improve the way dithered images turn out. For example, if your palette is dark, you can turn up the brightness.
If your palette (original or recolor) is low-spreadmeaning it doesn't span much of the available shades of a single hue or the entire RGB spaceyou can use flags like **\--brightness**, **\--contrast**, and **\--saturation** to improve the way dithered images turn out. For example, if your palette is dark, you can turn up the brightness. As mentioned above, these flags apply their transformations to the original image and will not adjust your selected palette colors.

# EXAMPLES

**didder --palette 'black white' -i input.jpg -o test.png bayer 16x16**


This command dithers `input.jpg` to just use black and white (implicitly converting to grayscale first), using a 16x16 Bayer matrix. The result is written to `test.png`.

TODO
This command dithers `input.jpg` using only black and white (implicitly converting to grayscale first), using a 16x16 Bayer matrix. The result is written to `test.png`.

# REPORTING BUGS

Any bugs can be reported by creating an issue on GitHub: <https://github.com/makeworld-the-better-one/didder>
Any bugs can be reported by creating an issue on GitHub: <https://github.com/makeworld-the-better-one/didder>
29 changes: 15 additions & 14 deletions didder.1
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
.hy
.SH NAME
.PP
didder - dither images
didder \[em] dither images
.SH SYNOPSIS
.PP
\f[B]didder\f[R] [global options] command [command options]
Expand All @@ -15,11 +15,11 @@ Dither images with a variety of algorithms and processing options.
.PP
Mandatory global flags are \f[B]--palette\f[R], \f[B]--in\f[R], and
\f[B]--out\f[R], all others are optional.
Each command represents a dithering algorithm or set of algorithms to
apply to the input image(s).
Each command applies a dithering algorithm or set of algorithms to the
input image(s).
.PP
The most important section in this manual is the \f[B]TIPS\f[R] one.
Make sure you check it out.
The most important parts of this manual are highlighted in the
\f[B]TIPS\f[R] section, make sure you check it out!
.PP
Homepage: <https://github.com/makeworld-the-better-one/didder>
.SH GLOBAL OPTIONS
Expand Down Expand Up @@ -197,7 +197,7 @@ This flag is ignored for non animated GIF output.
.TP
\f[B]-l\f[R], \f[B]--loop\f[R] \f[I]NUM\f[R]
Set the number of times animated GIF output should loop.
0 is the default, and means infinite looping.
0 is the default, and will loop infinitely.
.TP
\f[B]-x\f[R], \f[B]--width\f[R] \f[I]NUM\f[R]
Set the width the input image(s) will be resized to, before dithering.
Expand Down Expand Up @@ -468,14 +468,15 @@ then leave it.
.PP
If you need to scale it up afterward, use \f[B]--upscale\f[R], rather
than another tool.
This will prevent image artifacts or blurring.
This will prevent image artifacts and blurring.
.PP
Be wary of environments where you can\[cq]t make sure an image will be
displayed at 100% size, pixel for pixel.
Make sure nearest-neighbor scaling is being used at least.
Make sure to at least use nearest-neighbor scaling, do your best to
preserve sharp pixel edges.
.PP
Dithered images must only be encoded in a lossless image format.
This is why the tool only outputs PNG or GIF.
This is why the tool only outputs PNG and GIF.
.PP
To increase the dithering artifacts for aesthetic effect, you can
downscale the image before dithering and upscale after.
Expand All @@ -484,20 +485,20 @@ Like if the image is 1000 pixels tall, your command can look like
Depending on the input image size and what final size you want, you can
of course just upscale as well.
.PP
If your palette (original or recolor) is low-spread, meaning it
If your palette (original or recolor) is low-spread \[em] meaning it
doesn\[cq]t span much of the available shades of a single hue or the
entire RGB space, you can use flags like \f[B]--brightness\f[R],
entire RGB space \[em] you can use flags like \f[B]--brightness\f[R],
\f[B]--contrast\f[R], and \f[B]--saturation\f[R] to improve the way
dithered images turn out.
For example, if your palette is dark, you can turn up the brightness.
As mentioned above, these flags apply their transformations to the
original image and will not adjust your selected palette colors.
.SH EXAMPLES
.TP
\f[B]didder \[en]palette `black white' -i input.jpg -o test.png bayer 16x16\f[R]
This command dithers \f[C]input.jpg\f[R] to just use black and white
This command dithers \f[C]input.jpg\f[R] using only black and white
(implicitly converting to grayscale first), using a 16x16 Bayer matrix.
The result is written to \f[C]test.png\f[R].
.PP
TODO
.SH REPORTING BUGS
.PP
Any bugs can be reported by creating an issue on GitHub:
Expand Down

0 comments on commit 332664d

Please sign in to comment.