summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAlan Coopersmith <alan.coopersmith@oracle.com>2023-01-01 10:21:38 -0800
committerAlan Coopersmith <alan.coopersmith@oracle.com>2023-01-01 13:12:39 -0800
commit392cb8fb444ae632176829076f412cb4029dbdbc (patch)
tree94ee3ef630824e7142f9eaf60310299f41fd160e
parent08bc174f28af028b6ebaa9edeccd3ff56c396e92 (diff)
man pages: Fix typos and other minor editing
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
-rw-r--r--man/XpmCreateBuffer.man9
-rw-r--r--man/XpmCreateData.man2
-rw-r--r--man/XpmCreateImage.man2
-rw-r--r--man/XpmRead.man17
-rw-r--r--man/XpmWrite.man14
5 files changed, 27 insertions, 17 deletions
diff --git a/man/XpmCreateBuffer.man b/man/XpmCreateBuffer.man
index b1b02f6..6d4cc6a 100644
--- a/man/XpmCreateBuffer.man
+++ b/man/XpmCreateBuffer.man
@@ -24,7 +24,7 @@
.hw XImage
.TH XpmCreateBuffer __libmansuffix__ __xorgversion__ "libXpm functions"
.SH NAME
-XpmCreateBuffer \- create an Xpm-Buffer
+XpmCreateBuffer \- create an XPM Buffer
.SH SYNOPSIS
.HP
@@ -59,8 +59,9 @@ XpmFree when finished.
As a convenience, the XpmReadFileToBuffer and XpmWriteFileFromBuffer functions
are provided to copy a file to a buffer
-and to write a file from a buffer. Thus for instance one may decide to use XpmReadFileToBuffer,
-XpmCreatePixmapFromBuffer, and XpmFree instead of XpmReadFileToPixmap. On some systems this may lead to a
+and to write a file from a buffer. Thus for instance one may decide to use
+XpmCreateBufferFromPixmap, XpmWriteFileFromBuffer, and XpmFree instead of
+XpmWriteFileFromPixmap. On some systems this may lead to a
performance improvement, since the parsing will be performed in memory, but it uses more memory.
.SS XpmCreateBufferFromImage
@@ -69,7 +70,7 @@ The caller should free the buffer using XpmFree when finished.
.SS XpmCreateBufferFromXpmImage.
To create an XPM buffer from an XpmImage, use XpmCreateBufferFromXpmImage.
-The XpmCreateBufferFromXpmImage function writes out the givenimage to a single block malloc’ed buffer inXPM format.
+The XpmCreateBufferFromXpmImage function writes out the given image to a single block malloc’ed buffer in XPM format.
If insufficient working storage is allocated, it returns XpmNoMemory, and returns XpmSuccess on success.
If the passed XpmInfo structure pointer is not NULL, XpmCreateBufferFromXpmImage looks for the following
attributes: XpmComments, XpmExtensions, and XpmHotspot, and writes the related information out as well.
diff --git a/man/XpmCreateData.man b/man/XpmCreateData.man
index a4f332b..797ff56 100644
--- a/man/XpmCreateData.man
+++ b/man/XpmCreateData.man
@@ -66,7 +66,7 @@ Then it destroys the created images using XDestroyImage.
XpmCreateDataFromPixmap returns the same errors as XpmCreateDataFromImage.
.SS XpmCreateDataFromXpmImage
-XpmCreateDataFromXpmImage creates an XPM data from an XmImage.
+XpmCreateDataFromXpmImage creates an XPM data from an XpmImage.
The XpmCreateDataFromXpmImage function writes out the given image to a single block malloc’ed data in XPM format.
If insufficient working storage is allocated, it returns XpmNoMemory, and returns XpmSuccess on success.
If the passed XpmInfo structure pointer is not NULL, XpmCreateDataFromXpmImage looks for the following attributes:
diff --git a/man/XpmCreateImage.man b/man/XpmCreateImage.man
index fc68dbb..91065df 100644
--- a/man/XpmCreateImage.man
+++ b/man/XpmCreateImage.man
@@ -24,7 +24,7 @@
.hw XImage
.TH XpmCreateImage __libmansuffix__ __xorgversion__ "libXpm functions"
.SH NAME
-XpmCreateImage \- create an Xpm-image
+XpmCreateImage \- create an XImage from an XPM
.SH SYNOPSIS
.HP
int XpmCreateImageFromData(Display *display, char **data, XImage **image_return, XImage **shapeimage_return, XpmAttributes *attributes);
diff --git a/man/XpmRead.man b/man/XpmRead.man
index 49b0844..1c13353 100644
--- a/man/XpmRead.man
+++ b/man/XpmRead.man
@@ -66,7 +66,7 @@ If the file can be opened but does not contain valid XPM data, it returns XpmFil
If insufficient working storage is allocated, it returns XpmNoMemory.
If the passed XpmAttributes structure pointer is not NULL, XpmReadFileToImage looks for the following attributes:
XpmVisual, XpmColormap, XpmDepth, XpmColorSymbols, XpmExactColors, XpmCloseness,
-XpmRGBCloseness, XpmAllocCloseColors ,XpmReturnPixels, XpmReturnAllocPixels, XpmAllocColor,
+XpmRGBCloseness, XpmAllocCloseColors, XpmReturnPixels, XpmReturnAllocPixels, XpmAllocColor,
XpmFreeColors, XpmColorClosure, XpmReturnExtensions, XpmReturnColorTable, XpmBitmapFormat,
sets the XpmSize, the XpmCharsPerPixel, and possibly the XpmHotspot attributes when returning.
As a backward compatibility feature, XpmReadFileToImage also looks for the XpmReturnInfos attributes.
@@ -81,8 +81,8 @@ unpredictable errors can occur.
XpmReadFileToImage allocates colors, as read from the file or possibly overridden as specified in the
XpmColorSymbols attributes.
The colors are allocated using the color settings for the visual specified by the XpmColorKey
-attribute, which has the value XPM_MONO, XPM_GRAY4, XPM_GRAY,or XPM_COLOR.
-If the XpmColor-Key attribute is not set it is determined by examining the type of visual.
+attribute, which has the value XPM_MONO, XPM_GRAY4, XPM_GRAY, or XPM_COLOR.
+If the XpmColorKey attribute is not set it is determined by examining the type of visual.
If no default value exists for the specified visual, it first looks for other defaults nearer to the monochrome visual type
and secondly nearer to the color visual type.
If the color which is found is not valid (cannot be parsed), it looks for
@@ -140,16 +140,23 @@ XpmReadFileToBuffer returns XpmOpenFailed if it cannot open the file, returns Xp
working storage is allocated, and XpmSuccess otherwise. The allocated buffer returned by XpmReadFileToBuffer
should be freed with XpmFree when done.
+As a convenience, the XpmReadFileToBuffer and XpmWriteFileFromBuffer functions
+are provided to copy a file to a buffer and to write a file from a buffer.
+Thus for instance one may decide to use XpmReadFileToBuffer,
+XpmCreatePixmapFromBuffer, and XpmFree instead of XpmReadFileToPixmap.
+On some systems this may lead to a performance improvement,
+since the parsing will be performed in memory, but it uses more memory.
+
.SS XpmReadFileToData
XpmReadFileToData returns XpmOpenFailed if it cannot open the file,
XpmNoMemory if insufficient working storage is allocated,
-XpmFileInvalid if this is not a validXPM file, and XpmSuccess otherwise.
+XpmFileInvalid if this is not a valid XPM file, and XpmSuccess otherwise.
The allocated data returned by XpmReadFileToData should be freed with XpmFree when done.
.SS XpmReadFileToXpmImage
The XpmReadFileToXpmImage function reads in a file in the XPM format.
If the file cannot be opened it returns XpmOpenFailed.
-If the file can be opened but does not contain valid XPMdata,
+If the file can be opened but does not contain valid XPM data,
it returns XpmFileInvalid.
If insufficient working storage is allocated, it returns XpmNoMemory.
On success it fills in the given XpmImage structure and returns XpmSuccess.
diff --git a/man/XpmWrite.man b/man/XpmWrite.man
index cba91c1..1ec4661 100644
--- a/man/XpmWrite.man
+++ b/man/XpmWrite.man
@@ -78,7 +78,7 @@ Finally, if the XpmRgbFilenameattribute is defined, XpmWriteFileFromImage search
this file and if found writes them out instead of the rgb values.
In addition on systems which support such features if the given file name ends by ’.Z’ or ’.gz’
-it is assumed to be a compressed file. Then, XpmWriteFileFromImage writes to a pipedcompress or gzip process.
+it is assumed to be a compressed file. Then, XpmWriteFileFromImage writes to a piped compress or gzip process.
And if instead of a file name NULL is passed to XpmWriteFileFromImage, it writes to the standard output.
.SS XpmWriteFileFromPixmap
@@ -110,15 +110,17 @@ compressed file. Then, XpmWriteFileFromXpmImage writes to a piped compress or gz
of a file name NULL is passed to XpmWriteFileFromXpmImage, it writes to the standard output.
.SS XpmWriteFileFromBuffer
-XpmWriteFileFromBuffer writes a XPM-buffer to a file.
+XpmWriteFileFromBuffer writes a XPM buffer to a file.
XpmWriteFileFromBuffer returns XpmOpenFailed if it cannot open the file, and XpmSuccess otherwise.
-As a convenience, the XpmReadFileToBuffer and XpmWriteFileFromBuffer are provided to copy a
-file to a buffer and to write a file from a buffer.
-Thus for instance one may decide to use XpmReadFileToBuffer, XpmCreatePixmapFromBuffer, and XpmFree
-instead of XpmReadFileToPixmap. On some systems this may lead to a performance improvement,
+As a convenience, the XpmReadFileToBuffer and XpmWriteFileFromBuffer functions
+are provided to copy a file to a buffer and to write a file from a buffer.
+Thus for instance one may decide to use XpmCreateBufferFromPixmap,
+XpmWriteFileFromBuffer, and XpmFree instead of XpmWriteFileFromPixmap.
+On some systems this may lead to a performance improvement,
since the parsing will be performed in memory, but it uses more memory.
+
.SH "SEE ALSO"
.BR XpmWriteFileFromData(__libmansuffix__) ,
.BR XpmWriteFileFromPixmap(__libmansuffix__) ,