diff options
| author | Mattias Andrée <m@maandree.se> | 2026-02-22 14:24:38 +0100 |
|---|---|---|
| committer | Mattias Andrée <m@maandree.se> | 2026-02-22 14:24:38 +0100 |
| commit | 04b2aa793e46af6eb12489dc9aeafd5e5a0e02f3 (patch) | |
| tree | 0d6404fc656278f5ce456b0be9d5da2bc429304a | |
| parent | lss16toppm.1, ppmtolss16.1: m text fix (diff) | |
| download | liblss16-04b2aa793e46af6eb12489dc9aeafd5e5a0e02f3.tar.gz liblss16-04b2aa793e46af6eb12489dc9aeafd5e5a0e02f3.tar.bz2 liblss16-04b2aa793e46af6eb12489dc9aeafd5e5a0e02f3.tar.xz | |
Signed-off-by: Mattias Andrée <m@maandree.se>
| -rw-r--r-- | README | 8 | ||||
| -rw-r--r-- | liblss16.7 | 8 | ||||
| -rw-r--r-- | liblss16.h | 4 | ||||
| -rw-r--r-- | liblss16_decode_strerror.3 | 2 | ||||
| -rw-r--r-- | liblss16_decode_to_colour_index.3 | 12 | ||||
| -rw-r--r-- | liblss16_encode_from_colour_index.3 | 6 | ||||
| -rw-r--r-- | liblss16_encode_strerror.3 | 2 | ||||
| -rw-r--r-- | lss16.5 | 2 | ||||
| -rw-r--r-- | lss16toppm.1 | 4 | ||||
| -rw-r--r-- | ppmtolss16.1 | 4 | ||||
| -rw-r--r-- | ppmtolss16.c | 2 |
11 files changed, 27 insertions, 27 deletions
@@ -2,9 +2,9 @@ NAME liblss16 - Library for the SYSLINUX "ad hoc" LSS16 image format DESCRIPTION - liblss16 is a C library for encoding and decode the LSS16 image file + liblss16 is a C library for encoding and decoding the LSS16 image file format, which is a SYSLINUX "ad hoc" lossless, compressed, low-fidelity - image file format optimised bootloaders in low-end graphics + image file format optimised for bootloaders in low-end graphics environments. liblss16 provides the following functions for decoding LSS16 images: @@ -13,7 +13,7 @@ DESCRIPTION Prepare state for liblss16_decode_to_colour_index(3). liblss16_decode_to_colour_index(3) - Decode an file. The colour of each pixel is output with + Decode a file. The colour of each pixel is output with the index of the colour in the colour palette. liblss16_decode_strerror(3) @@ -29,7 +29,7 @@ DESCRIPTION Prepare state for liblss16_encode_from_colour_index(3). liblss16_encode_from_colour_index(3) - Encode an file. The colour of each pixle is input as the + Encode a file. The colour of each pixel is input as the index of the colour in the colour palette. liblss16_encode_strerror(3) @@ -4,9 +4,9 @@ liblss16 \- Library for the SYSLINUX \(dqad hoc\(dq LSS16 image format .SH DESCRIPTION .B liblss16 -is a C library for encoding and decode the LSS16 image file +is a C library for encoding and decoding the LSS16 image file format, which is a SYSLINUX \(dqad hoc\(dq lossless, compressed, -low-fidelity image file format optimised bootloaders in low-end +low-fidelity image file format optimised for bootloaders in low-end graphics environments. .PP .B liblss16 @@ -18,7 +18,7 @@ Prepare state for .BR liblss16_decode_to_colour_index (3). .TP .BR liblss16_decode_to_colour_index (3) -Decode an file. The colour of each pixel is output with +Decode a file. The colour of each pixel is output with the index of the colour in the colour palette. .TP .BR liblss16_decode_strerror (3) @@ -38,7 +38,7 @@ Prepare state for .BR liblss16_encode_from_colour_index (3). .TP .BR liblss16_encode_from_colour_index (3) -Encode an file. The colour of each pixle is input as +Encode a file. The colour of each pixel is input as the index of the colour in the colour palette. .TP .BR liblss16_encode_strerror (3) @@ -35,7 +35,7 @@ enum liblss16_decode_state { /** * A decoding error has occurred * - * Processing most be aborted + * Processing must be aborted */ LIBLSS16_DECODE_ERROR }; @@ -119,7 +119,7 @@ enum liblss16_encode_state { LIBLSS16_ENCODE_RUNNING, /** - * Encodig done + * Encoding done */ LIBLSS16_ENCODE_DONE }; diff --git a/liblss16_decode_strerror.3 b/liblss16_decode_strerror.3 index ee011ed..d95389d 100644 --- a/liblss16_decode_strerror.3 +++ b/liblss16_decode_strerror.3 @@ -17,7 +17,7 @@ Link with .SH DESCRIPTION The .BR liblss16_decode_strerror () -function returns a stirng the describes +function returns a string that describes .IR error . .PP The function is used for decoding errors, which may be diff --git a/liblss16_decode_to_colour_index.3 b/liblss16_decode_to_colour_index.3 index 797c4f5..7ed71f5 100644 --- a/liblss16_decode_to_colour_index.3 +++ b/liblss16_decode_to_colour_index.3 @@ -147,23 +147,23 @@ stored should the function fail. .SH RETURN VALUE The .BR liblss16_decode_to_colour_index () -function will returns the following values: +function will return the following values: .TP .B LIBLSS16_DECODE_RUNNING The end of the image has not yet been reached. -The file if truncated if the end of the file is reached. +The file is truncated if the end of the file is reached. .TP .B LIBLSS16_DECODE_END_OF_IMAGE -The end of the image is reched. +The end of the image is reached. If the end of the file has not yet been reached, it contains extraneous data. .TP .B LIBLSS16_DECODE_ERROR -A decoding error has occured, and processing most be -aborted. This always indicate that the file is corrupted +A decoding error has occurred, and processing must be +aborted. This always indicates that the file is corrupted or not an LSS16 file. .I *error_out -will be se to indicate the error unless +will be set to indicate the error unless .I error_out is .IR NULL . diff --git a/liblss16_encode_from_colour_index.3 b/liblss16_encode_from_colour_index.3 index 9a55c09..0801590 100644 --- a/liblss16_encode_from_colour_index.3 +++ b/liblss16_encode_from_colour_index.3 @@ -27,12 +27,12 @@ The .BR liblss16_encode_from_colour_index () function encodes an image as in LSS16 file. Before beginning the encoding, the application -must first initalise +must first initialise .I encoder with its initial state and image meta data using the .BR liblss16_encoder_init (3) -function. After than, the +function. After that, the .BR liblss16_encode_from_colour_index () function is called repeatedly until it returns .BR LIBLSS16_ENCODE_DONE . @@ -88,7 +88,7 @@ The function returns .B LIBLSS16_ENCODE_RUNNING until the last byte for the LSS16 file -hsa been written. Once the last byte +has been written. Once the last byte has been written, it returns .BR LIBLSS16_ENCODE_DONE . Note that diff --git a/liblss16_encode_strerror.3 b/liblss16_encode_strerror.3 index 758c887..399df8b 100644 --- a/liblss16_encode_strerror.3 +++ b/liblss16_encode_strerror.3 @@ -17,7 +17,7 @@ Link with .SH DESCRIPTION The .BR liblss16_encode_strerror () -function returns a stirng the describes +function returns a string that describes .IR error . .PP The function is used for encoding errors, which may be @@ -17,7 +17,7 @@ Header format: Image width (number of pixels horizontally): unsigned 16-bit integer, little endian. Image height (number of pixels horizontally): unsigned 16-bit integer, little endian, -however the most significant bit most be cleared. +however the most significant bit must be cleared. Colour palette: 16 RGB-tuples, each tuple is 3 bytes: red, green, blue. The two most significant bits in each byte must be cleared. diff --git a/lss16toppm.1 b/lss16toppm.1 index c34cb5e..988f28d 100644 --- a/lss16toppm.1 +++ b/lss16toppm.1 @@ -2,7 +2,7 @@ .SH NAME lss16toppm \- Convert an LSS16 file to a Portable Pixmap (PPM) file -.SH SYNPOSIS +.SH SYNOPSIS .B lss16toppm .RB [ -map ] .RI "< " lss16-file @@ -76,7 +76,7 @@ Successful completion. The standard input is not an valid LSS16 file. .TP 2 -An error occured. +An error occurred. .SH NOTES The SYSLINUX implementation of the diff --git a/ppmtolss16.1 b/ppmtolss16.1 index c7946c2..edfad63 100644 --- a/ppmtolss16.1 +++ b/ppmtolss16.1 @@ -2,7 +2,7 @@ .SH NAME ppmtolss16 \- Convert a Portable Anymap (PNM) file to an LSS16 file -.SH SYNPOSIS +.SH SYNOPSIS .B ppmtolss16 .RI "< " pnm-file .RI "> " lss16-file @@ -58,7 +58,7 @@ The standard input is not an valid P1-P6 Portable Anymap file. The image is too large to be encoded with LSS16. .TP 3 -An error occured. +An error occurred. .SH NOTES The SYSLINUX implementation of the diff --git a/ppmtolss16.c b/ppmtolss16.c index c852263..1f2ec1a 100644 --- a/ppmtolss16.c +++ b/ppmtolss16.c @@ -55,7 +55,7 @@ __attribute__((__noreturn__)) static void not_pnm(void) { - fprintf(stderr, "%s: <stdin> is no a P1-P6 Portable Anymap file\n", argv0); + fprintf(stderr, "%s: <stdin> is not a P1-P6 Portable Anymap file\n", argv0); exit(1); } |
