From 3433f4334db7c30864c112639a929c5ae8bd3c3b Mon Sep 17 00:00:00 2001 From: Alan Coopersmith Date: Sun, 17 Jul 2022 16:27:01 -0700 Subject: man: strip trailing whitespace git diff -w shows no changes from this commit Signed-off-by: Alan Coopersmith --- man/Makefile.am | 18 +++--- man/xpmcreatebuffer.man | 64 +++++++++---------- man/xpmcreatedata.man | 66 +++++++++---------- man/xpmcreateimage.man | 68 ++++++++++---------- man/xpmcreatepixmap.man | 68 ++++++++++---------- man/xpmcreatexpmimage.man | 84 ++++++++++++------------ man/xpmmisc.man | 60 ++++++++--------- man/xpmread.man | 160 +++++++++++++++++++++++----------------------- man/xpmwrite.man | 106 +++++++++++++++--------------- 9 files changed, 347 insertions(+), 347 deletions(-) diff --git a/man/Makefile.am b/man/Makefile.am index b422a50..952d911 100644 --- a/man/Makefile.am +++ b/man/Makefile.am @@ -35,7 +35,7 @@ libman_PRE=$(all_shadows:=.man) \ libman_DATA = $(libman_PRE:man=$(LIB_MAN_SUFFIX)) -appman_PRE = sxpm.man cxpm.man +appman_PRE = sxpm.man cxpm.man appman_DATA = $(appman_PRE:man=$(APP_MAN_SUFFIX)) EXTRA_DIST = $(appman_PRE) $(libman_PRE) @@ -50,29 +50,29 @@ all_shadows = \ $(xpmcreatexpmimage_shadows) \ $(xpmmisc_shadows) \ $(xpmread_shadows) \ - $(xpmwrite_shadows) + $(xpmwrite_shadows) xpmcreatebuffer_shadows = \ XpmCreateBufferFromImage \ XpmCreateBufferFromPixmap \ - XpmCreateBufferFromXpmImage + XpmCreateBufferFromXpmImage xpmcreatedata_shadows = \ XpmCreateDataFromImage \ XpmCreateDataFromPixmap \ - XpmCreateDataFromXpmImage + XpmCreateDataFromXpmImage xpmcreateimage_shadows = \ XpmCreateImageFromBuffer \ XpmCreateImageFromData \ - XpmCreateImageFromXpmImage + XpmCreateImageFromXpmImage xpmcreatepixmap_shadows = \ XpmCreatePixmapFromBuffer \ XpmCreatePixmapFromData \ - XpmCreatePixmapFromXpmImage + XpmCreatePixmapFromXpmImage xpmcreatexpmimage_shadows = \ XpmCreateXpmImageFromBuffer \ XpmCreateXpmImageFromData \ XpmCreateXpmImageFromImage \ - XpmCreateXpmImageFromPixmap + XpmCreateXpmImageFromPixmap xpmmisc_shadows = \ XpmLibraryVersion \ XpmGetErrorString \ @@ -81,7 +81,7 @@ xpmmisc_shadows = \ XpmAttributesSize \ XpmFreeAttributes \ XpmFreeXpmImage \ - XpmFreeXpmInfo + XpmFreeXpmInfo xpmread_shadows = \ XpmReadFileToImage \ XpmReadFileToPixmap \ @@ -93,7 +93,7 @@ xpmwrite_shadows = \ XpmWriteFileFromPixmap \ XpmWriteFileFromImage \ XpmWriteFileFromXpmImage \ - XpmWriteFileFromBuffer + XpmWriteFileFromBuffer # String replacements in MAN_SUBSTS now come from xorg-macros.m4 via configure .man.$(APP_MAN_SUFFIX): diff --git a/man/xpmcreatebuffer.man b/man/xpmcreatebuffer.man index ce9ce6b..56afd67 100644 --- a/man/xpmcreatebuffer.man +++ b/man/xpmcreatebuffer.man @@ -1,30 +1,30 @@ -.\" 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. +.\" 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 XpmCreateBuffer __libmansuffix__ __xorgversion__ "libXpm functions" -.SH NAME +.TH XpmCreateBuffer __libmansuffix__ __xorgversion__ "libXpm functions" +.SH NAME XpmCreateBuffer \- create an Xpm-Buffer .SH SYNOPSIS @@ -54,28 +54,28 @@ Specifies the location of a structure to get possible information (or NULL). .SS XpmCreateBufferFromPixmap XpmCreateBufferFromPixmap creates an XPM buffer from a Pixmap. -The XpmCreateBufferFromPixmap function works as XpmWriteFileFromPixmap(), it just calls +The XpmCreateBufferFromPixmap function works as XpmWriteFileFromPixmap(), it just calls XpmCreateBufferFromImage instead of XpmWriteFileFromImage. Once again, the caller should free the buffer using XpmFree when finished. 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 +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 XpmCreateBufferFromImage -The XpmCreateBufferFromImage works as XpmWriteFileFromImage(), it just writes to a malloc’ed buffer instead of to a file. +The XpmCreateBufferFromImage works as XpmWriteFileFromImage(), it just writes to a malloc’ed buffer instead of to a file. The caller should free the buffer using XpmFree when finished. .SS XpmCreateBufferFromXpmImage. To create an XPM buffer from an XpmImage, use XpmCreateBufferFromXpmImage. -The XpmCreateBufferFromXpmImage writes out the givenimage to a single block malloc’ed buffer inXPM format. +The XpmCreateBufferFromXpmImage writes out the givenimage to a single block malloc’ed buffer inXPM 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 +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. The caller should free the buffer using XpmFree when finished. -.SH "SEE ALSO" +.SH "SEE ALSO" .BR XpmCreateBufferFromImage(__libmansuffix__) , .BR XpmCreateBufferFromPixmap(__libmansuffix__) , .BR XpmCreateBufferFromXpmImage(__libmansuffix__) diff --git a/man/xpmcreatedata.man b/man/xpmcreatedata.man index 91cd7df..384a95d 100644 --- a/man/xpmcreatedata.man +++ b/man/xpmcreatedata.man @@ -1,30 +1,30 @@ -.\" 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. +.\" 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 XpmCreateData __libmansuffix__ __xorgversion__ "libXpm functions" -.SH NAME +.TH XpmCreateData __libmansuffix__ __xorgversion__ "libXpm functions" +.SH NAME XpmCreateData \- create an Data structure .SH SYNOPSIS @@ -55,26 +55,26 @@ 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. -It just writes to a single block malloc’ed data instead of to a file. +The XpmCreateDataFromImage function exactly works asXpmWriteFileFromImage() 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. .SS XpmCreateDataFromPixmap XpmCreateDataFromPixmap creates an XPM data from a Pixmap. -The XpmCreateDataFromPixmap function uses XGetImage to get from the given pixmaps -the related X images which are passed to XpmCreateDataFromImage. -Then it destroys the created images using XDestroyImage. +The XpmCreateDataFromPixmap function uses XGetImage to get from the given pixmaps +the related X images which are passed to XpmCreateDataFromImage. +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. -The XpmCreateDataFromXpmImage function writes out the given image to a single block malloc’ed data in XPM format. +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: +If the passed XpmInfo structure pointer is not NULL, XpmCreateDataFromXpmImage looks for the following attributes: XpmExtensions, and XpmHotspot, and writes the related information out as well. It is the caller’s responsibility to free the data, using XpmFree when finished. -.SH "SEE ALSO" +.SH "SEE ALSO" .BR XpmCreateDataFromImage(__libmansuffix__) , .BR XpmCreateDataFromPixmap(__libmansuffix__) , .BR XpmCreateDataFromXpmImage(__libmansuffix__) diff --git a/man/xpmcreateimage.man b/man/xpmcreateimage.man index a25027b..f614ea7 100644 --- a/man/xpmcreateimage.man +++ b/man/xpmcreateimage.man @@ -1,31 +1,31 @@ -.\" 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. +.\" 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 XpmCreateImage __libmansuffix__ __xorgversion__ "libXpm functions" -.SH NAME -XpmCreateImage \- create an Xpm-image +.TH XpmCreateImage __libmansuffix__ __xorgversion__ "libXpm functions" +.SH NAME +XpmCreateImage \- create an Xpm-image .SH SYNOPSIS .HP int XpmCreateImageFromData( Display *display, char **data, XImage **image_return, XImage **shapeimage_return, XpmAttributes *attributes ); @@ -54,29 +54,29 @@ Specifies the shape mask image which is created if any. .SS XpmCreateImageFromData To create an XImage from an XPM data, use XpmCreateImageFromData. -The XpmCreateImageFromData function allows you to include in your C program an XPM file which was +The XpmCreateImageFromData function allows you to include in your C program an XPM file which was 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 +It just reads data instead of a file. +Here again, it is the caller’s responsibeility to free the returned images, the colors and possibly the data returned into the XpmAttributes structure. .SS XpmCreateImageFromBuffer To create an XImage from an XPM buffer, use XpmCreateImageFromBuffer. -The XpmCreateImageFromBuffer works the same way as XpmReadFileToImage(), -it just parses the buffer instead of the file. -Be aware that the feature provided on some systems by XpmReadFileToImage +The XpmCreateImageFromBuffer works the same way as XpmReadFileToImage(), +it just parses the buffer instead of the file. +Be aware that the feature provided on some systems by XpmReadFileToImage to deal with compressed files is not available here. .SS XpmCreateImageFromXpmImage To create an XImage from an XpmImage, use XpmCreateImageFromXpmImage. From the given XpmImage and XpmAttributes if not NULL, XpmCreateImageFromXpmImage allocates colors and creates X images following the same mechanism as XpmReadFileToImage(). -When finished the caller must free the images using XDestroyImage, +When finished the caller must free the images using XDestroyImage, the colors using XFreeColors, and possibly the data returned into the XpmAttributes using XpmFreeAttributes(). -.SH "SEE ALSO" +.SH "SEE ALSO" .BR XpmCreateImageFromBuffer(__libmansuffix__) , .BR XpmCreateImageFromData(__libmansuffix__) , .BR XpmCreateImageFromXpmImage(__libmansuffix__) diff --git a/man/xpmcreatepixmap.man b/man/xpmcreatepixmap.man index ba116b3..80dded1 100644 --- a/man/xpmcreatepixmap.man +++ b/man/xpmcreatepixmap.man @@ -1,31 +1,31 @@ -.\" 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. +.\" 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 XpmCreatePixmap __libmansuffix__ __xorgversion__ "libXpm functions" -.SH NAME -XpmCreatePixmap \- create a pixmap +.TH XpmCreatePixmap __libmansuffix__ __xorgversion__ "libXpm functions" +.SH NAME +XpmCreatePixmap \- create a pixmap .SH SYNOPSIS .HP int XpmCreatePixmapFromData( Display *display, Drawable d, char **data, Pixmap *pixmap_return, Pixmap *shapemask_return, XpmAttributes *attributes ); @@ -34,7 +34,7 @@ int XpmCreatePixmapFromBuffer( Display *display, Drawable d, char *buffer, Pixma .HP int XpmCreatePixmapFromXpmImage( Display *display, Drawable d, XpmImage *image, Pixmap *pixmap_return, Pixmap *shapemask_return, XpmAttributes *attributes; -.SH ARGUMENTS +.SH ARGUMENTS .IP \fIdisplay\fP li Specifies the connection to the X server. @@ -49,31 +49,31 @@ Returns the shape mask pixmap which is created if the color None is used. .IP \fIattributes\fP li Specifies the location of a structure to get and store information. .IP \fIimage\fP li -Specifies the XpmImage. +Specifies the XpmImage. .SH DESCRIPTION .SS XpmCreatePixmapFromData To create a Pixmap from an XPM data, use XpmCreatePixmapFromData. The XpmCreatePixmapFromData function creates X images using XpmCreateImageFromData() and -thus returns the same errors. In addition on success it then creates the related pixmaps, using XPutImage, +thus returns the same errors. In addition on success it then creates the related pixmaps, using XPutImage, which are returned to pixmap_return and shapemask_return if not NULL, and finally destroys the created images using XDestroyImage. Do not forget to free the returned pixmaps, the colors, and possibly the data returned into the XpmAttributes structure when done. .SS XpmCreatePixmapFromBuffer -To create a Pixmap from an XPM buffer, use XpmCreatePixmapFromBuffer. -The XpmCreatePixmapFromBuffer function works the same way as XpmReadFileToPixmap (), +To create a Pixmap from an XPM buffer, use XpmCreatePixmapFromBuffer. +The XpmCreatePixmapFromBuffer function works the same way as XpmReadFileToPixmap (), it just calls XpmCreateImageFromBuffer instead of XpmReadFileToImage. .SS XpmCreatePixmapFromXpmImage XpmCreatePixmapFromXpmImage creates X images calling XpmCreateImageFromXpmImage () with the given XpmImage and XpmAttributes, then it creates the related pixmaps which are returned topixmap_return -and shapemask_return using XPutImage. +and shapemask_return using XPutImage. Finally it destroys the X images with XDestroyImage. When finished the caller must free the pixmaps using XFreePixmap, the 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. -.SH "SEE ALSO" -.BR XpmCreatePixmapFromBuffer(__libmansuffix__) , +.SH "SEE ALSO" +.BR XpmCreatePixmapFromBuffer(__libmansuffix__) , .BR XpmCreatePixmapFromData(__libmansuffix__) , .BR XpmCreatePixmapFromXpmImage(__libmansuffix__) diff --git a/man/xpmcreatexpmimage.man b/man/xpmcreatexpmimage.man index 305ea13..cd810fe 100644 --- a/man/xpmcreatexpmimage.man +++ b/man/xpmcreatexpmimage.man @@ -1,31 +1,31 @@ -.\" 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. +.\" 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 XpmCreateXpmImage __libmansuffix__ __xorgversion__ "libXpm functions" -.SH NAME -XpmCreateXpmImage \- create an Xpm image +.TH XpmCreateXpmImage __libmansuffix__ __xorgversion__ "libXpm functions" +.SH NAME +XpmCreateXpmImage \- create an Xpm image .SH SYNOPSIS .HP @@ -36,7 +36,7 @@ int XpmCreateXpmImageFromBuffer( char *buffer, XpmImage *image, XpmInfo *info ); int XpmCreateXpmImageFromImage( Display *display, XImage *image, XImage *shapeimage, XpmImage *xpmimage, XpmAttributes *attributes; .HP int XpmCreateXpmImageFromPixmap( Display *display, Pixmap *pixmap, Pixmap *shapemask, XpmImage *xpmimage, XpmAttributes *attributes ); - + .SH ARGUMENTS .IP \fIdata\fP li @@ -59,17 +59,17 @@ Specifies the location of a structure containing information (or NULL). .SH DESCRIPTION .SS XpmCreateXpmImageFromBuffer To create an XpmImage from an XPM buffer, use XpmCreateXpmImageFromBuffer. -The XpmCreateXpmImageFromBuffer reads the given buffer to fill in the given XpmImage structure. -If the buffer does not contain valid XPM data, it returns XpmFileInvalid. +The XpmCreateXpmImageFromBuffer reads the given buffer to fill in the given XpmImage structure. +If the buffer does not contain valid XPM data, it returns XpmFileInvalid. If insufficient working storage is allocated, it returns XpmNoMemory, and returns XpmSuccess on success. -If the passed XpmInfo structure pointer is not NULL, XpmCreateXpmImageFromBuffer looks for the following attributes: -XpmReturnComments and XpmReturnExtensions, and sets possibly the XpmHotspot attribute when returning. -As specified in the table (page 28), if the data related to the attributes XpmReturnComments and +If the passed XpmInfo structure pointer is not NULL, XpmCreateXpmImageFromBuffer looks for the following attributes: +XpmReturnComments and XpmReturnExtensions, and sets possibly the XpmHotspot attribute when returning. +As specified in the table (page 28), if the data related to the attributes XpmReturnComments and XpmReturnExtensions cannot be returned as requested because of insufficient memory storage, -XpmCreateXpmImageFromBuffer will change the valuemask to mention this and will try to continue. +XpmCreateXpmImageFromBuffer will change the valuemask to mention this and will try to continue. So the caller should check on this before accessing requested data. -Note: The valuemask of the passed XpmInfo structure must be set to some valid value, +Note: The valuemask of the passed XpmInfo structure must be set to some valid value, at least zero, otherwise unpredictable errors can occur. .SS XpmCreateXpmImageFromData @@ -77,31 +77,31 @@ 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 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. +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 -try to continue. +try to continue. So the caller should check on this before accessing requested data. -Note: The valuemask of the passed XpmInfo structure must be set to some valid value, at least zero, +Note: The valuemask of the passed XpmInfo structure must be set to some valid value, at least zero, otherwise unpredictable errors can occur. .SS XpmCreateXpmImageFromImage To create an XpmImage from an XImage, use XpmCreateXpmImageFromImage. -From the given X images and XpmAttributes if not NULL, XpmCreateXpmImageFromImage creates an +From the given X images and XpmAttributes if not NULL, XpmCreateXpmImageFromImage creates an 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. +XpmImage which is returned to xpmimage. Finally it destroys the created X images using XDestroyImage. -.SH "SEE ALSO" +.SH "SEE ALSO" .BR XpmCreateXpmImageFromBuffer(__libmansuffix__) , .BR XpmCreateXpmImageFromData(__libmansuffix__) , .BR XpmCreateXpmImageFromImage(__libmansuffix__) , diff --git a/man/xpmmisc.man b/man/xpmmisc.man index ee8b37b..a5444d1 100644 --- a/man/xpmmisc.man +++ b/man/xpmmisc.man @@ -1,31 +1,31 @@ -.\" 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. +.\" 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 xpmmisc __libmansuffix__ __xorgversion__ "libXpm functions" -.SH NAME -Xpmmisc \- xpm misc functions to free used memory and handle errors +.TH xpmmisc __libmansuffix__ __xorgversion__ "libXpm functions" +.SH NAME +Xpmmisc \- xpm misc functions to free used memory and handle errors .SH SYNOPSIS .HP @@ -71,8 +71,8 @@ To free possible data stored into an XpmInfo structure use XpmFreeXpmInfo. To free data possibly stored into an array of XpmExtension use XpmFreeExtensions. To free any data allocated by an XPM function use the XpmFree function. -The current distribution of the XPM library uses the standard memory allocation functions and thus -XpmFree is nothing else than a define to the standard free. +The current distribution of the XPM library uses the standard memory allocation functions and thus +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. @@ -97,7 +97,7 @@ only if the API changes), and XpmRevision is the library minor version number. The XpmFreeExtensions function frees all data stored in every extension and the array itself. Note that XpmFreeAttributes call this function and thus most of the time it should not need to be explicitly called. -.SH "SEE ALSO" +.SH "SEE ALSO" .BR XpmLibraryVersion(__libmansuffix__) , .BR XpmGetErrorString(__libmansuffix__) , .BR XpmFree(__libmansuffix__) , @@ -105,4 +105,4 @@ Note that XpmFreeAttributes call this function and thus most of the time it shou .BR XpmAttributesSize(__libmansuffix__) , .BR XpmFreeAttributes(__libmansuffix__) , .BR XpmFreeXpmImage(__libmansuffix__) , -.BR XpmFreeXpmInfo(__libmansuffix__) \ No newline at end of file +.BR XpmFreeXpmInfo(__libmansuffix__) diff --git a/man/xpmread.man b/man/xpmread.man index 8b6f637..8b264d2 100644 --- a/man/xpmread.man +++ b/man/xpmread.man @@ -1,30 +1,30 @@ -.\" 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. +.\" 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 XpmRead __libmansuffix__ __xorgversion__ "libXpm functions" -.SH NAME +.TH XpmRead __libmansuffix__ __xorgversion__ "libXpm functions" +.SH NAME XpmRead \- read an XPM file .SH SYNOPSIS @@ -38,7 +38,7 @@ int XpmReadFileToXpmImage( char *filename, XpmImage *image, XpmInfo *info ); int XpmReadFileToBuffer( char *filename, char **buffer_return ); .HP int XpmReadFileToData( char *filename, char ***data_return ); - + .SH ARGUMENTS .IP \fIdisplay\fP li Specifies the connection to the X server. @@ -61,75 +61,75 @@ Specifies the location of a structure to store possible information (or NULL). .SH DESCRIPTION .SS XpmReadFileToImage -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. +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: -XpmVisual, XpmColormap, XpmDepth, XpmColorSymbols, XpmExactColors, XpmCloseness, +If the passedXpmAttributes 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, -sets the XpmSize, the XpmCharsPerPixel, and possibly the XpmHotspot attributes when returning. -As a backward compatibility feature, XpmReadFileToImage also looks for the XpmReturnInfos attributes. -As specified in the table (page 12), if the data related to the attributes XpmReturnExtensions, -XpmReturnColorTable, and XpmReturnInfos cannot be returned as requested because of insufficient +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. +As specified in the table (page 12), if the data related to the attributes XpmReturnExtensions, +XpmReturnColorTable, and XpmReturnInfos cannot be returned as requested because of insufficient memory storage, XpmReadFileToImage will change the valuemask to -mention this and will try to continue. +mention this and will try to continue. So the caller should check on this before accessing this data. -Note: The valuemask of the passed XpmAttributes must be set to some valid value, at least zero, otherwise +Note: The valuemask of the passed XpmAttributes must be set to some valid value, at least zero, otherwise unpredictable errors can occur. -XpmReadFileToImage allocates colors, as read from the file or possibly overridden as specified in the -XpmColorSymbols attributes. +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. +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. 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. +and secondly nearer to the color visual type. If the color which is found is not valid (cannot be parsed), it looks for another default one according to the same algorithm. If allocating a color fails, and the closeness attribute is set, it tries to find a color already in the colormap that is closest -to the desired color, and uses that. -If the alloc_close_colors attribute is set to False, the found close color is not allocated but it is used anyway. -This is especially useful for applications which use a private colormap containing read/write cells and have -complete control over the colormap. -On the other hand, since in such a case there is no guarantee that the color pixel will not change any time, -this should be avoided when using the default colormap. -If no color can be found that is within closeness of the Red, Green and Blue components of the desired color, -it reverts to trying other default values as explained above. -For finer control over the closeness requirements of a particular icon, +to the desired color, and uses that. +If the alloc_close_colors attribute is set to False, the found close color is not allocated but it is used anyway. +This is especially useful for applications which use a private colormap containing read/write cells and have +complete control over the colormap. +On the other hand, since in such a case there is no guarantee that the color pixel will not change any time, +this should be avoided when using the default colormap. +If no color can be found that is within closeness of the Red, Green and Blue components of the desired color, +it reverts to trying other default values as explained above. +For finer control over the closeness requirements of a particular icon, the red_closeness, green_closeness, and blue_closeness attributes may be used instead of the more general closeness attribute. -The RGB components are integers within the range 0 (black) to 65535 (white). A closeness of less than 10000, -for example, will cause only quite close colors to be matched, while a closeness of more than 50000 will -allow quite dissimilar colors to match. +The RGB components are integers within the range 0 (black) to 65535 (white). A closeness of less than 10000, +for example, will cause only quite close colors to be matched, while a closeness of more than 50000 will +allow quite dissimilar colors to match. Specifying a closeness of more than 65535 will allow any color to match, thus forcing the icon -to be drawn in color no matter how bad the colormap is. +to be drawn in color no matter how bad the colormap is. The value 40000 seems to be about right for many situations requiring reasonable but not perfect matches. With this setting the color must only be within the same general area of the RGB cube as the desired color. -If the exactColors attribute is set it then returns XpmColorError, otherwise it creates the images and returns XpmSuccess. +If the exactColors attribute is set it then returns XpmColorError, otherwise it creates the images and returns XpmSuccess. If no color is found, and no close color exists or is wanted, and all visuals have been exhausted, XpmColorFailed is returned. -XpmReadFileToImage returns the created image to image_return if not NULL and possibly the -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. +XpmReadFileToImage returns the created image to image_return if not NULL and possibly the +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 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, +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 -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. +an uncompress orgzip 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. .SS XpmReadFileToPixmap -The XpmReadFileToPixmap function creates X images using XpmReadFileToImage and thus returns the same errors. -In addition on success it then creates the related pixmaps, using XPutImage, +The XpmReadFileToPixmap function creates X images using XpmReadFileToImage and thus returns the same errors. +In addition on success it then creates the related pixmaps, using XPutImage, which are returned to pixmap_return and shapemask_return if not NULL, and finally destroys the created images using XDestroyImage. When finished the caller must free the pixmaps using XFreePixmap, 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 @@ -142,22 +142,22 @@ working storage is allocated, andXpmSuccess otherwise. The allocated buffer retu should be freed with XpmFree when done. .SS XpmReadFileToData -XpmReadFileToData returns XpmOpenFailed if it cannot open the file, +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 validXPM 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, -it returns XpmFileInvalid. -If insufficient working storage is allocated, it returnsXpmNoMemory. +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. On success it fills in the given XpmImage structure and returns XpmSuccess. -.SH "SEE ALSO" -.BR XpmReadFileToImage(__libmansuffix__) , -.BR XpmReadFileToPixmap(__libmansuffix__) , -.BR XpmReadFileToBuffer(__libmansuffix__) , -.BR XpmReadFileToData(__libmansuffix__) -.BR XpmReadFileToXpmImage(__libmansuffix__) \ No newline at end of file +.SH "SEE ALSO" +.BR XpmReadFileToImage(__libmansuffix__) , +.BR XpmReadFileToPixmap(__libmansuffix__) , +.BR XpmReadFileToBuffer(__libmansuffix__) , +.BR XpmReadFileToData(__libmansuffix__) +.BR XpmReadFileToXpmImage(__libmansuffix__) diff --git a/man/xpmwrite.man b/man/xpmwrite.man index b07f780..b840e97 100644 --- a/man/xpmwrite.man +++ b/man/xpmwrite.man @@ -1,30 +1,30 @@ -.\" 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. +.\" 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 +.TH XpmWrite __libmansuffix__ __xorgversion__ "libXpm functions" +.SH NAME XpmWrite \- write an XPM file .SH SYNOPSIS @@ -64,32 +64,32 @@ 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 insufficient working storage is allocated, it returns XpmNoMemory. +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, +If the passed XpmAttributes structure pointer is not NULL, XpmWriteFileFromImage looks for the following attributes: -XpmColormap, XpmHotspot, XpmCharsPerPixel, XpmRgbFilename, and XpmExtensions. +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 +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 +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. +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, +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. +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 @@ -100,11 +100,11 @@ 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. +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: +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 @@ -114,15 +114,15 @@ of a file name NULL is passed to XpmWriteFileFromXpmImage, it writes to the stan 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 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__) +.SH "SEE ALSO" +.BR XpmWriteFileFromData(__libmansuffix__) , +.BR XpmWriteFileFromPixmap(__libmansuffix__) , +.BR XpmWriteFileFromImage(__libmansuffix__) , +.BR XpmWriteFileFromXpmImage(__libmansuffix__) , +.BR XpmWriteFileFromBuffer(__libmansuffix__) -- cgit v1.2.3