1 files changed, 93 insertions, 0 deletions
diff --git a/ppmtolss16.1 b/ppmtolss16.1
new file mode 100644
index 0000000..7bb3516
--- /dev/null
+++ b/ppmtolss16.1
@@ -0,0 +1,93 @@
+.TH PPMTOLSS16 1 LIBLSS16
+.SH NAME
+ppmtolss16 \- Convert a Portable Anymap (PNM) file to an LSS16 file
+
+.SH SYNPOSIS
+.B ppmtolss16
+.RI "< " pnm-file
+.RI "> " lss16-file
+
+.SH DESCRIPTION
+The
+.B ppmtolss16
+utility converts the Portable Anymap (PNM) image file
+.I pnm-file
+to an LSS16 image file, and stores it as
+.IR lss16-file.
+.PP
+Despite the name
+.BR ppmtolss16 ,
+the
+.N ppmtolss16
+utility supports Portable Bitmap (PBM) and Portable Greymap (PGM)
+in addition to Portable Pixmaps (PPM). Both plain (P1, P2, P3)
+and raw (P4, P5, P6) files are supported.
+
+.SH OPTIONS
+None, not even
+.RB \(dq -- \(dq.
+
+.SH OPERANDS
+None.
+
+.SH STDIN
+The standard input shall be the Portable Anymap file to convert.
+
+.SH INPUT FILES
+None.
+
+.SH STDOUT
+The image will be printed as an LSS16 file to the standard output.
+
+.SH STDERR
+The standard error is used for diagnostic purposes.
+
+.SH OUTPUT FILES
+None.
+
+.SH EXIT STATUS
+The following exit values are returned:
+.TP
+0
+Successful completion.
+.TP
+1
+The standard input is not an valid P1-P6 Portable Anymap file.
+.TP
+2
+The image is too large to be encoded with LSS16.
+.TP
+3
+An error occured.
+
+.SH NOTES
+The SYSLINUX implementation of the
+.BR ppmtolss16
+utility does used the exit valuess
+.B 2
+and
+.BR 3 ,
+but instead always returns 1 on failure.
+
+.SH RATIONALE
+The invocation syntax and the name of the utility is
+inherited from the SYSLINUX implementation of
+.BR ppmtolss16 .
+.PP
+SYSLINUX's implementation of
+.BR ppmtolss16
+supports forcing the colour palette, however because this
+feature was poorly documented, misleading, and not generally
+useful, this implementation does not support this.
+
+.SH HISTORY
+Early versions of SYSLINUX's implementation of
+.BR ppmtolss16
+only supported raw Portable Pixmap (P6 PPM) files
+without comments.
+
+.SH SEE ALSO
+.BR lss16 (5),
+.BR lss16toppm (1),
+.BR liblss16 (7),
+.BR syslinux (1)