source: trunk/SRC/Documentation/idldoc_html_output/Postscript/printps.html @ 402

Last change on this file since 402 was 402, checked in by smasson, 15 years ago

update documentation
File size: 8.5 KB
Line 
1
2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
3 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
4
5<!-- Generated by IDLdoc 2.0 -->
6
7<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
8  <head>
9    <title>printps.pro (SAXO Documentation)</title>
10
11   
12    <link rel="stylesheet" type="text/css" media="all" href="./../main_files.css" />
13    <link rel="stylesheet" type="text/css" media="print" href="./../main_files_print.css" />
14   
15
16    <script type="text/javascript">
17      function setTitle() {
18        parent.document.title="printps.pro (SAXO Documentation)";
19      }
20    </script>
21  </head>
22
23  <body onload="setTitle();">
24
25    <div id="navbar_title">
26  <h1>SAXO Documentation</h1>
27</div>
28
29
30<div id="main_navbar">
31
32  <table cellspacing="0">
33    <tr>
34     
35      <td><a href="./../overview.html" title="Overview of library">Overview</a></td>
36     
37
38     
39      <td >Directory</td>
40     
41
42     
43      <td><a href="./../idldoc-categories.html" title="Browse library by category">Categories</a></td>
44     
45
46     
47      <td><a href="./../idldoc-index.html" title="Index of files, routines, and parameters">Index</a></td>
48     
49
50     
51      <td><a href="./../search-page.html" title="Search library">Search</a></td>
52     
53
54      <td id="selected">File</td>
55
56     
57      <td><a href="../../../Postscript//printps.pro" title="Source code of a file">Source</a></td>
58     
59
60     
61      <td><a href="./../idldoc-help.html" title="Help on IDLdoc">Help</a></td>
62     
63
64      <td >Etc</td>
65
66      <td id="flexible">Developer&nbsp;documentation</td>
67    </tr>
68  </table>
69
70</div>
71
72<div id="secondary_navbar">
73
74<a href="openps.html">&lt;&lt;prev file</a> | next file &gt;&gt;&nbsp;&nbsp;&nbsp;&nbsp;<a href="printps.html" target="_TOP">view single page</a> | <a href="./../index.html" target="_TOP">view frames</a>&nbsp;&nbsp;&nbsp;&nbsp;summary: fields | <a href="#routine_summary">routine</a>&nbsp;&nbsp;&nbsp;&nbsp;details: <a href="#routine_details">routine</a>
75
76</div>
77
78
79    <div id="container">
80
81      <h1 class="directory"><a href="directory-overview.html">Postscript/</a></h1>
82      <h2 class="pro_file">printps.pro</h2>
83
84      <div id="file_attr">
85        <dl>
86        </dl>
87      </div>
88
89      <div id="file_comments">
90 - archiving possibilities -
91
92 if archive_ps (common variable of cm_4ps) ne 0 then the postscript
93 can be saved for archiving if it is printed or if the button
94 "archive ps" is pressed. if it is printed and archive_ps = 1 then
95 the archiving is done automatically whereas we ask if the postscript
96 file must be archived or not.
97 If the postscript name is "idl.ps" (default name) then this name will
98 be changed to number.ps (number automatically found to be 1 larger
99 that any of the existing ps file).
100
101
102 postscript visualisation/archiving/printing
103</div>
104
105     
106
107     
108
109     
110
111     
112      <div id="routine_summary">               
113        <h2>Routine summary</h2>
114       
115        <dl>
116         
117          <dt><p><a href="#_printps_event">printps_event<span class="result">, event</span>, uval=<span class="result">uval</span></a></p><dt>
118          <dd> </dd>   
119         
120          <dt><p><a href="#_printps">printps<span class="result">[, psfilename]</span>, ARCHIVE=<span class="result">integer 0 or 1</span>, DIRECTPRINT=<span class="result">string</span></a></p><dt>
121          <dd></dd>     
122               
123        </dl>
124      </div>
125     
126
127      <div id="routine_details">
128       
129
130        <div class="routine_details" id="_printps_event">
131
132          <h2><a class="top" href="#container">top</a>printps_event <span class="categories">
133 Postscripts
134</span></h2>
135       
136          <p class="header">
137            printps_event<span class="result">, <a href="#_printps_event_param_event">event</a></span>, <a href="#_printps_event_keyword_uval">uval</a>=<span class="result">uval</span></p>
138       
139          <div class="comments">
140</div>
141
142         
143
144         
145            <h3>Parameters</h3>
146       
147           
148            <h4 id="_printps_event_param_event">event&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
149             
150             
151             
152             
153             
154             
155             
156             
157            </h4>
158       
159          <div class="comments">
160</div>
161           
162
163         
164
165         
166
167            <h3>Keywords</h3>
168           
169            <h4 id="_printps_event_keyword_uval">uval&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
170             
171             
172             
173             
174             
175             
176             
177             
178            </h4>
179       
180            <div class="comments"></div>
181           
182         
183
184         
185          <h3>Version history</h3>
186         
187          <h4>Version</h4><div class="preformat">
188 $Id: printps.pro 401 2009-07-23 08:48:16Z smasson $
189</div>
190          <h4>History</h4><div class="preformat">
191 Sebastien Masson (smasson@lodyc.jussieu.fr)
192                        21/12/98
193                       25/8/19999 utilisation des widgets
194                       8/9/1999 utilisation de cw_bgroup
195 June 2005: Sebastien Masson: cleaning, English version with new commons
196</div>
197         
198         
199          <h3>Known issues</h3>
200         
201         
202         
203          <h4>Restrictions</h4><div class="preformat">
204
205 1) this is working only with unix/linux/osX machines
206
207 2) definition of the printing command
208
209 the printing command is defined by the common variable "print_command"
210 in cm_4ps. This command must be defined/build in a way that it the
211 instruction:
212     print_command[i]+printer_machine_names[i]+' '+file.ps
213 or
214     print_command+printer_machine_names[i]+' '+file.ps
215 is working. default definition is 'lpr -P'
216
217</div>
218       
219         
220         
221         
222         
223         
224         
225         
226       
227          <h3>Statistics</h3>
228          <table class="statistics">
229            <tr><td>McCabe cyclic</td><td>          54</td></tr>
230            <tr><td>McCabe essential</td><td>           1</td></tr>
231            <tr><td>McCabe modular design</td><td>           1</td></tr>
232          </table>
233         
234       
235        </div>
236       
237
238        <div class="routine_details" id="_printps">
239
240          <h2><a class="top" href="#container">top</a>printps <span class="categories">
241 Postscripts
242</span></h2>
243       
244          <p class="header">
245            printps<span class="result">[, <a href="#_printps_param_psfilename">psfilename</a>]</span>, <a href="#_printps_keyword_ARCHIVE">ARCHIVE</a>=<span class="result">integer 0 or 1</span>, <a href="#_printps_keyword_DIRECTPRINT">DIRECTPRINT</a>=<span class="result">string</span></p>
246       
247          <div class="comments"></div>
248
249         
250
251         
252            <h3>Parameters</h3>
253       
254           
255            <h4 id="_printps_param_psfilename">psfilename&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
256              <span class="attr">in</span>
257             
258              <span class="attr">optional</span>
259             
260             
261             
262             
263             
264            </h4>
265       
266          <div class="comments">
267 The name of the postscript file we want to
268 visualize and/or print and/or archive. It can also refer
269 to a gzipped postscript file. If needed, this name will
270 be completed by .ps and/or .gz.
271</div>
272           
273
274         
275
276         
277
278            <h3>Keywords</h3>
279           
280            <h4 id="_printps_keyword_ARCHIVE">ARCHIVE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
281             
282             
283             
284             
285             
286              <span class="attr">type:</span> <span class="value">integer 0 or 1</span>
287              <span class="attr">default:</span> <span class="value">0</span>
288             
289            </h4>
290       
291            <div class="comments">
292 activate to bypass the widget and directly archive the postcript
293 (useful to use printps in batch mode)
294</div>
295           
296            <h4 id="_printps_keyword_DIRECTPRINT">DIRECTPRINT&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
297             
298             
299             
300             
301             
302              <span class="attr">type:</span> <span class="value">string</span>
303              <span class="attr">default:</span> <span class="value">not defined</span>
304             
305            </h4>
306       
307            <div class="comments">
308 bypass the widget and directly define the printer that must be used
309 to print the postcript file. DIRECTPRINT must correspond to one of
310 the names defined in the comoon variables printer_machine_names or
311 printer_human_names. useful to use printps in batch mode
312</div>
313           
314         
315
316          <h3>Examples</h3><div class="preformat">
317
318   IDL> printps
319</div>
320          <h3>Version history</h3>
321         
322          <h4>Version</h4><div class="preformat">
323 $Id: printps.pro 401 2009-07-23 08:48:16Z smasson $
324</div>
325          <h4>History</h4><div class="preformat">
326 Sebastien Masson (smasson@lodyc.jussieu.fr)
327                        21/12/98
328                       25/8/19999 utilisation des widgets
329                       8/9/1999 utilisation de cw_bgroup
330 June 2005: Sebastien Masson: cleaning, English version with new commons
331</div>
332         
333         
334         
335         
336         
337         
338         
339       
340          <h3>Other attributes</h3>
341         
342         
343          <h4>Uses routines</h4><div class="preformat">
344 <a href="..//Commons/cm_4ps.html">cm_4ps</a>
345</div>
346         
347         
348         
349       
350          <h3>Statistics</h3>
351          <table class="statistics">
352            <tr><td>McCabe cyclic</td><td>          27</td></tr>
353            <tr><td>McCabe essential</td><td>           1</td></tr>
354            <tr><td>McCabe modular design</td><td>           1</td></tr>
355          </table>
356         
357       
358        </div>
359       
360      </div>
361
362     
363
364      <div id="tagline">Produced by IDLdoc 2.0.</div>
365
366    </div>
367
368  </body>
369</html>
Note: See TracBrowser for help on using the repository browser.