File: PS_open_image_file.sgml

package info (click to toggle)
pslib 0.4.8-1
  • links: PTS
  • area: main
  • in suites: forky, sid, trixie
  • size: 2,808 kB
  • sloc: ansic: 9,602; sh: 4,382; makefile: 246
file content (121 lines) | stat: -rw-r--r-- 3,919 bytes parent folder | download | duplicates (4)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
<!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [

<!-- Process this file with docbook-to-man to generate an nroff manual
     page: `docbook-to-man manpage.sgml > manpage.1'.  You may view
     the manual page with: `docbook-to-man manpage.sgml | nroff -man |
     less'.  A typical entry in a Makefile or Makefile.am is:

manpage.1: manpage.sgml
	docbook-to-man $< > $@

    
	The docbook-to-man binary is found in the docbook-to-man package.
	Please remember that if you create the nroff version in one of the
	debian/rules file targets (such as build), you will need to include
	docbook-to-man in your Build-Depends control field.

  -->

  <!-- Fill in your name for FIRSTNAME and SURNAME. -->
  <!ENTITY dhfirstname "<firstname>UWE</firstname>">
  <!ENTITY dhsurname   "<surname>STEINMANN</surname>">
  <!-- Please adjust the date whenever revising the manpage. -->
  <!ENTITY dhdate      "<date>March 28, 2011</date>">
  <!-- SECTION should be 1-8, maybe w/ subsection other parameters are
       allowed: see man(7), man(1). -->
  <!ENTITY dhsection   "<manvolnum>3</manvolnum>">
  <!ENTITY dhemail     "<email>uwe@steinmann.cx</email>">
  <!ENTITY dhusername  "Uwe Steinmann">
  <!ENTITY dhucpackage "<refentrytitle>PS_OPEN_IMAGE_FILE</refentrytitle>">
  <!ENTITY funcname    "PS_open_image_file">

  <!ENTITY debian      "<productname>Debian</productname>">
  <!ENTITY gnu         "<acronym>GNU</acronym>">
  <!ENTITY gpl         "&gnu; <acronym>GPL</acronym>">
]>

<refentry>
  <refentryinfo>
    <address>
      &dhemail;
    </address>
    <author>
      &dhfirstname;
      &dhsurname;
    </author>
    <copyright>
      <year>2003-2011</year>
      <holder>&dhusername;</holder>
    </copyright>
    &dhdate;
  </refentryinfo>
  <refmeta>
    &dhucpackage;

    &dhsection;
  </refmeta>
  <refnamediv>
    <refname>&funcname;</refname>

    <refpurpose>Opens an image from file</refpurpose>
  </refnamediv>
  <refsynopsisdiv>
    <para>#include &lt;pslib.h&gt;</para>
		<para>int &funcname;(PSDoc *psdoc, const char *type, const char *filename, const char *stringparam, int intparam)</para>
  </refsynopsisdiv>
  <refsect1>
    <title>DESCRIPTION</title>

    <para>This function reads image data from a file. It can read png, jpeg,
		  gif, tiff, and eps files. png, jpeg, gif, and tiff images can only
			be read if pslib has been compiled with support for those formats.
			Once an image has been loaded it can be placed on a page with
			<function>PS_place_image(3)</function>.</para>
		<para>Since version 0.4.5 of pslib images are read by default for later
			reuse. This means that the image is saved into a so called reusable
			stream object. Later calls of <function>PS_place_image(3)</function>
			will only put a short
			sequence of postscript code into the output file replaying the image.
			This reduces the overall postscript file size, speeds up its processing by
			the postscript rip and allows to place images into templates. This
			behaviour can be turned off by setting the parameter `imagereuse'
			to false with <function>PS_set_parameter(3)</function>.</para>

  </refsect1>
  <refsect1>
    <title>RETURN VALUE</title>
    <para>Returns identifier of image or zero in case of an error.
		  The identifier is a positiv number greater 0.</para>
  </refsect1>
  <refsect1>
    <title>SEE ALSO</title>

    <para>PS_open_image(3), PS_place_image(3), PS_close_image(3)</para>

  </refsect1>
  <refsect1>
    <title>AUTHOR</title>

    <para>This manual page was written by &dhusername; &dhemail;.</para>

  </refsect1>
</refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:2
sgml-indent-data:t
sgml-parent-document:nil
sgml-default-dtd-file:nil
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
-->