summaryrefslogtreecommitdiff
path: root/2ff.1
diff options
context:
space:
mode:
authorFRIGN <dev@frign.de>2016-01-05 16:38:12 +0100
committerFRIGN <dev@frign.de>2016-01-05 16:38:12 +0100
commit24c4b045fc495becc9ba4239ba3d2963851c7634 (patch)
tree1579a11c9e144c929027e0a49a6f775ccffa1407 /2ff.1
parentba154494ae239b9a79fc0947cad497e983c80653 (diff)
Add tool manpages and set up the Makefile to install the manuals
While at it, refactor the makefile a bit.
Diffstat (limited to '2ff.1')
-rw-r--r--2ff.151
1 files changed, 51 insertions, 0 deletions
diff --git a/2ff.1 b/2ff.1
new file mode 100644
index 0000000..44eed4e
--- /dev/null
+++ b/2ff.1
@@ -0,0 +1,51 @@
+.Dd 2016-01-05
+.Dt 2FF 1
+.Os suckless.org
+.Sh NAME
+.Nm 2ff
+.Nd convert image to farbfeld
+.Sh SYNOPSIS
+.Nm
+.Sh DESCRIPTION
+.Nm
+reads an image from stdin, converts it to
+.Xr farbfeld 5
+and writes the result to stdout.
+.Pp
+.Nm
+is a wrapper script around the *2ff-tools
+with a soft fallback to obtaining a PNG from imagemagick's
+.Xr convert 1
+and passing it through
+.Xr png2ff 1 .
+.Pp
+In case of an error
+.Nm
+writes a diagnostic message to stderr.
+.Sh EXIT STATUS
+.Bl -tag -width Ds
+.It 0
+Image processed successfully.
+.It 1
+An error occurred or
+.Xr convert 1
+was not found in the fallback.
+.El
+.Sh EXAMPLES
+$
+.Nm
+< image.* > image.ff
+.Pp
+$
+.Nm
+< image.* | bzip2 > image.ff.bz2
+.Sh SEE ALSO
+.Xr bunzip2 1 ,
+.Xr bzip2 1 ,
+.Xr convert 1 ,
+.Xr ff2png 1 ,
+.Xr jpg2ff 1 ,
+.Xr png2ff 1 ,
+.Xr farbfeld 5
+.Sh AUTHORS
+.An Laslo Hunhold Aq Mt dev@frign.de