1 files changed, 128 insertions, 0 deletions
diff --git a/man/XpmWrite.man b/man/XpmWrite.man
new file mode 100644
index 0000000..b840e97
--- /dev/null
+++ b/man/XpmWrite.man
@@ -0,0 +1,128 @@
+.\" Copyright (c) 2019  X Consortium
+.\"
+.\" Permission is hereby granted, free of charge, to any person obtaining
+.\" a copy of this software and associated documentation files (the
+.\" "Software"), to deal in the Software without restriction, including
+.\" without limitation the rights to use, copy, modify, merge, publish,
+.\" distribute, sublicense, and/or sell copies of the Software, and to
+.\" permit persons to whom the Software furnished to do so, subject to
+.\" the following conditions: .\" .\" The above copyright notice and this permission notice shall be included
+.\" in all copies or substantial portions of the Software.
+.\"
+.\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
+.\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+.\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+.\" IN NO EVENT SHALL THE X CONSORTIUM BE LIABLE FOR ANY CLAIM, DAMAGES OR
+.\" OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
+.\" ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+.\" OTHER DEALINGS IN THE SOFTWARE.
+.\"
+.\" Except as contained in this notice, the name of the X Consortium shall
+.\" not be used in advertising or otherwise to promote the sale, use or
+.\" other dealing in this Software without prior written authorization
+.\" from the X Consortium.
+.\"
+.hw XImage
+.TH XpmWrite __libmansuffix__ __xorgversion__ "libXpm functions"
+.SH NAME
+XpmWrite \- write an XPM file
+
+.SH SYNOPSIS
+.HP
+int XpmWriteFileFromPixmap( Display *display, char *filename, Pixmap pixmap, Pixmap shapemask, XpmAttributes *attributes );
+.HP
+int XpmWriteFileFromImage( Display *display, char *filename, XImage *image, XImage *shapeimage, XpmAttributes *attributes );
+.HP
+int XpmWriteFileFromData( char *filename, char **data );
+.HP
+int XpmWriteFileFromXpmImage( char *filename, XpmImage *image, XImage *shapeimage, XpmInfo *info );
+.HP
+int XpmWriteFileFromBuffer( char *filename,  char *buffer );
+
+.SH ARGUMENTS
+
+.IP \fIdisplay\fP li
+Specifies the connection to the X server.
+.IP \fIfilename\fP li
+Specifies the file name to use.
+.IP \fIpixmap\fP li
+Specifies the pixmap.
+.IP \fIshapemask\fP li
+Specifies the shape mask pixmap.
+.IP \fIattributes\fP li
+Specifies the location of a structure containing information (or NULL).
+.IP \fIdata\fP li
+Specifies the data array to read.
+.IP \fIimage\fP li
+Specifies the image.
+.IP \fIinfo\fP li
+Specifies the location of a structure to get information from (or NULL).
+.IP \fIbuffer\fP li
+Specifies the buffer to read.
+
+.SH DESCRIPTION
+.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 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,
+XpmWriteFileFromImage looks for the following attributes:
+XpmColormap, XpmHotspot, XpmCharsPerPixel, XpmRgbFilename, and XpmExtensions.
+As a backward compatibility feature, XpmWriteFileFromImage also looks for the XpmInfos attributes.
+If the filename contains an extension such as “.xpm”, in order to get a valid C variable name, the dot character is
+replaced by an underscore ’_’ when writing out.
+As a backward compatibility feature, if the XpmInfos attributes are defined it writes out possible stored
+information such as comments, color defaults and symbol.
+Finally, if the XpmRgbFilenameattribute is defined, XpmWriteFileFromImage searches for color names in
+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.
+And if instead of a file name NULL is passed to XpmWriteFileFromImage, it writes to the standard output.
+
+.SS XpmWriteFileFromPixmap
+To write out a Pixmap to an XPM file, use XpmWriteFileFromPixmap.
+
+If the passed XpmAttributes structure pointer is not NULL,
+XpmWriteFileFromPixmap looks for the following attributes: XpmSize.
+If they are not defined it performs an XGetGeometry operation.
+Then it uses XGetImage to get from the given pixmaps the related X images which are passed to XpmWriteFileFromImage.
+Finally XpmWriteFileFromPixmap destroys the created images using XDestroyImage.
+The XpmWriteFileFromPixmap function returns the same errors as XpmWriteFileFromImage.
+
+.SS XpmWriteFileFromData
+XpmWriteFileFromData writes an XPM data array to an XPM file.
+
+XpmWriteFileToData returns XpmOpenFailed if it cannot open the file,
+XpmFileInvalid if this is not a valid XPM data, and XpmSuccess otherwise.
+
+.SS XpmWriteFileFromXpmImage
+To write out an XpmImage to an XPM file, use XpmWriteFileFromXpmImage.
+The XpmWriteFileFromXpmImage function writes an image out to a file in the XPM format.
+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 XpmInfo structure pointer is not NULL, XpmWriteFileFromXpmImage looks for the following attributes:
+XpmComments, XpmExtensions, and XpmHotspot, and writes the related information out as well.
+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, XpmWriteFileFromXpmImage writes to a piped compress or gzip process. And if instead
+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 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,
+since the parsing will be performed in memory, but it uses more memory.
+
+.SH "SEE ALSO"
+.BR XpmWriteFileFromData(__libmansuffix__) ,
+.BR XpmWriteFileFromPixmap(__libmansuffix__) ,
+.BR XpmWriteFileFromImage(__libmansuffix__) ,
+.BR XpmWriteFileFromXpmImage(__libmansuffix__) ,
+.BR XpmWriteFileFromBuffer(__libmansuffix__)