From deb81a9a210527b0a00f002b1796e5e21e492879 Mon Sep 17 00:00:00 2001 From: Alan Coopersmith Date: Fri, 26 Aug 2022 18:39:17 -0700 Subject: man pages: Fix typos Signed-off-by: Alan Coopersmith --- man/XpmCreateData.man | 2 +- man/XpmCreateImage.man | 2 +- man/XpmCreateXpmImage.man | 6 +++--- man/XpmMisc.man | 4 ++-- man/XpmRead.man | 12 ++++++------ man/XpmWrite.man | 4 ++-- 6 files changed, 15 insertions(+), 15 deletions(-) (limited to 'man') diff --git a/man/XpmCreateData.man b/man/XpmCreateData.man index ac41d30..5b8c23b 100644 --- a/man/XpmCreateData.man +++ b/man/XpmCreateData.man @@ -55,7 +55,7 @@ Specifies the image .SH DESCRIPTION .SS XpmCreateDataFromImage In some cases, one may want to create an XPM data from an XImage, to do so use XpmCreateDataFromImage. -The XpmCreateDataFromImage function exactly works asXpmWriteFileFromImage() does and returns the same way. +The XpmCreateDataFromImage function exactly works as XpmWriteFileFromImage() does and returns the same way. It just writes to a single block malloc’ed data instead of to a file. It is the caller’s responsibility to free the data, using XpmFree when finished. diff --git a/man/XpmCreateImage.man b/man/XpmCreateImage.man index 024a29e..09c0351 100644 --- a/man/XpmCreateImage.man +++ b/man/XpmCreateImage.man @@ -58,7 +58,7 @@ The XpmCreateImageFromData function allows you to include in your C program an X written out by functions such as XpmWriteFileFromImage or XpmWriteFileFromPixmap without reading in the file. XpmCreateImageFromData exactly works as XpmReadFileToImage() does and returns the same way. It just reads data instead of a file. -Here again, it is the caller’s responsibeility to free the returned images, the colors +Here again, it is the caller’s responsibility to free the returned images, the colors and possibly the data returned into the XpmAttributes structure. .SS XpmCreateImageFromBuffer diff --git a/man/XpmCreateXpmImage.man b/man/XpmCreateXpmImage.man index 692ac48..156ce25 100644 --- a/man/XpmCreateXpmImage.man +++ b/man/XpmCreateXpmImage.man @@ -75,13 +75,13 @@ at least zero, otherwise unpredictable errors can occur. .SS XpmCreateXpmImageFromData To create an XpmImage from an XPM data, use XpmCreateXpmImageFromData. XpmCreateXpmImageFromData fills in the given XpmImage structure from the given data. If the data does not -contain validXPM data, it returnsXpmFileInvalid. If insufficient working storage is allocated, it returns +contain validXPM data, it returns XpmFileInvalid. If insufficient working storage is allocated, it returns XpmNoMemory, on success it returns XpmSuccess. If the passed XpmInfo structure pointer is not NULL, XpmCreateXpmImageFromData looks for the following attributes: XpmReturnExtensions, and sets possibly the XpmHotspot attribute when returning. As specified in the table (page 28), if the data related to the attribute XpmReturnExtensions cannot be returned as requested because of -insufficient memory storage,XpmCreateXpmImageFromData will change the valuemask to mention this and will +insufficient memory storage, XpmCreateXpmImageFromData will change the valuemask to mention this and will try to continue. So the caller should check on this before accessing requested data. @@ -95,7 +95,7 @@ XpmImage following the same mechanism as XpmWriteFileFromImage. .SS XpmCreateXpmImageFromPixmap To create an XpmImage from a Pixmap, use XpmCreateXpmImageFromPixmap. -From the given pixmaps and XpmAttributes if not NULL, XpmCreateXpmImageFromPixmap gets the related Ximages +From the given pixmaps and XpmAttributes if not NULL, XpmCreateXpmImageFromPixmap gets the related XImages by calling XGetImage, then it gives them to XpmCreateXpmImageFromImage() to create an XpmImage which is returned to xpmimage. Finally it destroys the created X images using XDestroyImage. diff --git a/man/XpmMisc.man b/man/XpmMisc.man index 3fed6dd..55759e0 100644 --- a/man/XpmMisc.man +++ b/man/XpmMisc.man @@ -75,12 +75,12 @@ The current distribution of the XPM library uses the standard memory allocation XpmFree is nothing else than a define to the standard free. However since these functions may be redefined in specific environments it is wise to use XpmFree. -To free possible data stored into an XpmAttributes structure use XpmFreeAtatributes. +To free possible data stored into an XpmAttributes structure use XpmFreeAttributes. The XpmFreeAttributes function frees the structure members which have been malloc’ed such as the pixels list. To dynamically allocate an XpmAttributes structure use the XpmAttributesSize function. The XpmAttributesSize function provides application using dynamic libraries with a safe way to allocate and then -refer to an XpmAttributesstructure, disregarding whether the XpmAttributes structure size has changed or not since +refer to an XpmAttributes structure, disregarding whether the XpmAttributes structure size has changed or not since compiled. To get data when building an error message, one can use XpmGetErrorString. XpmGetErrorString returns a string related to the given XPM error code. diff --git a/man/XpmRead.man b/man/XpmRead.man index 70e3a63..104e27e 100644 --- a/man/XpmRead.man +++ b/man/XpmRead.man @@ -65,7 +65,7 @@ The XpmReadFileToImage 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 XPM data, it returns XpmFileInvalid. If insufficient working storage is allocated, it returns XpmNoMemory. -If the passedXpmAttributes structure pointer is not NULL, XpmReadFileToImage looks for the following attributes: +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, XpmFreeColors, XpmColorClosure, XpmReturnExtensions, XpmReturnColorTable, XpmBitmapFormat, @@ -117,15 +117,15 @@ XpmReadFileToImage returns the created image to image_return if not NULL and pos created shapemask to shapeimage_return if not NULL and the color None is used. If required it stores into the XpmAttributes structure the list of the used pixels. When the image depth is one, the image format is either as specified by the bitmap_format attribute if set or ZPixmap. -When the depth is different from one the imagae format is always ZPixmap. +When the depth is different from one the image format is always ZPixmap. When finished the caller must free the images using XDestroyImage, the allocated colors using XFreeColors or the application equivalent function when the standard Xlib functions are not used, and possibly the data returned into the XpmAttributes using XpmFreeAttributes (page 25). In addition, on systems which support such features XpmReadFileToImage deals with compressed files by forking -an uncompress orgzip process and reading from the piped result. It assumes that the specified file is +an uncompress or gzip process and reading from the piped result. It assumes that the specified file is compressed if the given file name ends by ’.Z’ or ’.gz’. In case the file name does not end so, XpmReadFileToImage looks for the given file name assuming it is not a compressed file. -And if instead of a file name NULL is passed to XpmReadFile ToImage, it reads from the standard input. +And if instead of a file name NULL is passed to XpmReadFileToImage, it reads from the standard input. .SS XpmReadFileToPixmap The XpmReadFileToPixmap function creates X images using XpmReadFileToImage and thus returns the same errors. @@ -138,7 +138,7 @@ XpmAttributes using XpmFreeAttributes. .SS XpmReadFileToBuffer XpmReadFileToBuffer allocates and fills a buffer from a file. XpmReadFileToBuffer returns XpmOpenFailed if it cannot open the file, returns XpmNoMemory if insufficient -working storage is allocated, andXpmSuccess otherwise. The allocated buffer returned by XpmReadFileToBuffer +working storage is allocated, and XpmSuccess otherwise. The allocated buffer returned by XpmReadFileToBuffer should be freed with XpmFree when done. .SS XpmReadFileToData @@ -152,7 +152,7 @@ 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, it returns XpmFileInvalid. -If insufficient working storage is allocated, it returnsXpmNoMemory. +If insufficient working storage is allocated, it returns XpmNoMemory. On success it fills in the given XpmImage structure and returns XpmSuccess. .SH "SEE ALSO" diff --git a/man/XpmWrite.man b/man/XpmWrite.man index 43ca2c3..1086c3a 100644 --- a/man/XpmWrite.man +++ b/man/XpmWrite.man @@ -64,7 +64,7 @@ Specifies the buffer to read. .SS XpmWriteFileFromImage The XpmWriteFileFromImage function writes an image and its possible shapeimage out to a file in the XPM format. -If the file cannot be opened, it returnsXpmOpenFailed. +If the file cannot be opened, it returns XpmOpenFailed. If insufficient working storage is allocated, it returns XpmNoMemory. If no error occurs then it returns XpmSuccess. If the passed XpmAttributes structure pointer is not NULL, @@ -79,7 +79,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 pipedcompress or gzip process. And if instead of a file name NULL is passed to XpmWriteFileFromImage, it writes to the standard output. .SS XpmWriteFileFromPixmap -- cgit v1.2.1