summaryrefslogtreecommitdiff
path: root/farbfeld.5
diff options
context:
space:
mode:
authorLaslo Hunhold <dev@frign.de>2017-04-14 20:04:40 +0200
committerLaslo Hunhold <dev@frign.de>2017-04-14 20:04:40 +0200
commit48bd9e1f4c7c4c45957575f68b1ee0cdeba42fd3 (patch)
tree1d9a6faeefd042357550f20e38ee37c768d06974 /farbfeld.5
parent3d73fbaa1aeab1000d7f77cd6ee21f06a9b02e04 (diff)
Update and refactor the manpages
Make them more consistent, and only maintain a list of the conversion tools in farbfeld.5. Refine the wording on the jpg-manpages.
Diffstat (limited to 'farbfeld.5')
-rw-r--r--farbfeld.529
1 files changed, 19 insertions, 10 deletions
diff --git a/farbfeld.5 b/farbfeld.5
index b9308b1..accae57 100644
--- a/farbfeld.5
+++ b/farbfeld.5
@@ -1,4 +1,4 @@
-.Dd 2016-01-04
+.Dd 2017-04-14
.Dt FARBFELD 5
.Os suckless.org
.Sh NAME
@@ -17,17 +17,24 @@ BYTES DESCRIPTION
4 32-Bit BE unsigned integer (height)
[2222] 4*16-Bit BE unsigned integers [RGBA] / pixel, row-major
.Ed
+.Pp
The RGB-data should be sRGB for best interoperability and not
alpha-premultiplied.
.Sh USAGE
.Nm
-provides
-.Xr png2ff 1 ,
-.Xr jpg2ff 1 ,
+provides the tools
.Xr 2ff 1 ,
-.Xr ff2png 1
-for
-.Em conversions ;
+.Xr jpg2ff 1 ,
+.Xr png2ff 1
+and
+.Xr ff2jpg 1 ,
+.Xr ff2pam 1 ,
+.Xr ff2png 1 ,
+.Xr ff2ppm 1
+to
+.Em convert
+to and from farbfeld images respectively.
+.Pp
.Xr bzip2 1
is recommended for
.Em compression ,
@@ -42,8 +49,8 @@ appended (e.g. ".ff.bz2").
.Nm
was created because the author was not satisfied with the boilerplate
and inherent complexity involved in handling common image formats
-(PNG, JPEG, GIF,...), having to rely on bloated libraries not being able
-to focus on the task at hand for a given problem.
+(PNG, JPEG, GIF,...), having to rely on bloated libraries while not being
+able to focus on the task at hand for a given image processing problem.
.Sh EXAMPLES
Below is an example for a color inverter usable in a pipeline. No external
libraries other than libc are needed to handle the image data:
@@ -115,8 +122,10 @@ main(int argc, char *argv[])
.Ed
.Sh SEE ALSO
.Xr 2ff 1 ,
-.Xr bzip2 1 ,
+.Xr ff2jpg 1 ,
+.Xr ff2pam 1 ,
.Xr ff2png 1 ,
+.Xr ff2ppm 1 ,
.Xr jpg2ff 1 ,
.Xr png2ff 1
.Sh AUTHORS