Mercurial > octave

comparison scripts/plot/print.m @ 10841:1577accf2ed8

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
print.m: Update documentation string. Change to active voice.
author Rik <octave@nomad.inbox5.com>
date Sun, 01 Aug 2010 07:20:28 -0700
parents 05ba991794d4
children d5a7db05d591
comparison
equal deleted inserted replaced
10840:89f4d7e294cc 10841:1577accf2ed8
19 ## -*- texinfo -*- 19 ## -*- texinfo -*-
20 ## @deftypefn {Function File} {} print () 20 ## @deftypefn {Function File} {} print ()
21 ## @deftypefnx {Function File} {} print (@var{options}) 21 ## @deftypefnx {Function File} {} print (@var{options})
22 ## @deftypefnx {Function File} {} print (@var{filename}, @var{options}) 22 ## @deftypefnx {Function File} {} print (@var{filename}, @var{options})
23 ## @deftypefnx {Function File} {} print (@var{h}, @var{filename}, @var{options}) 23 ## @deftypefnx {Function File} {} print (@var{h}, @var{filename}, @var{options})
24 ## Print a graph, or save it to a file 24 ## Print a plot, or save it to a file.
25 ## 25 ##
26 ## @var{filename} defines the file name of the output file. If the 26 ## @var{filename} specifies the name of the output file. If the
27 ## file name has no suffix, one is inferred from the specified 27 ## file name has no suffix, then one is inferred from the specified
28 ## device and appended to the file name. If no 28 ## device and appended to the file name. If no
29 ## filename is specified, the output is sent to the printer. 29 ## filename is specified the output is sent to the printer.
30 ## 30 ##
31 ## @var{h} specifies the figure handle. If no handle is specified 31 ## @var{h} specifies the figure handle to print. If no handle is specified
32 ## the handle for the current figure is used. 32 ## the handle for the current figure is used.
33 ## 33 ##
34 ## @var{options}: 34 ## @var{options}:
35 ## 35 ##
36 ## @table @code 36 ## @table @code
37 ## @item -f@var{h} 37 ## @item -f@var{h}
38 ## Specify the handle, @var{h}, of the figure to be printed. The 38 ## Specify the handle, @var{h}, of the figure to be printed. The
39 ## default is the current figure. 39 ## default is the current figure.
40 ## 40 ##
41 ## @item -P@var{printer} 41 ## @item -P@var{printer}
42 ## Set the @var{printer} name to which the graph is sent if no 42 ## Set the @var{printer} name to which the plot is sent when no
43 ## @var{filename} is specified. 43 ## @var{filename} is specified.
44 ## 44 ##
45 ## @item -G@var{ghostscript_command} 45 ## @item -G@var{ghostscript_command}
46 ## Specify the command for calling Ghostscript. For Unix and Windows, 46 ## Specify the command for invoking Ghostscript. The defaults for Unix and
47 ## the defaults are 'gs' and 'gswin32c', respectively. 47 ## Windows are 'gs' and 'gswin32c' respectively.
48 ## 48 ##
49 ## @item -color 49 ## @item -color
50 ## @itemx -mono 50 ## @itemx -mono
51 ## Monochrome or color lines. 51 ## Print monochrome or color lines.
52 ## 52 ##
53 ## @item -solid 53 ## @item -solid
54 ## @itemx -dashed 54 ## @itemx -dashed
55 ## Solid or dashed lines. 55 ## Print solid or dashed lines.
56 ## 56 ##
57 ## @item -portrait 57 ## @item -portrait
58 ## @itemx -landscape 58 ## @itemx -landscape
59 ## Specify the orientation of the plot for printed output. 59 ## Specify the orientation of the plot for printed output.
60 ## 60 ##
70 ## @item eps 70 ## @item eps
71 ## @itemx eps2 71 ## @itemx eps2
72 ## @itemx epsc 72 ## @itemx epsc
73 ## @itemx epsc2 73 ## @itemx epsc2
74 ## Encapsulated postscript (level 1 and 2, mono and color) 74 ## Encapsulated postscript (level 1 and 2, mono and color)
75 ##
75 ## @item tex 76 ## @item tex
76 ## @itemx epslatex 77 ## @itemx epslatex
77 ## @itemx epslatexstandalone 78 ## @itemx epslatexstandalone
78 ## @itemx pstex 79 ## @itemx pstex
79 ## @itemx pslatex 80 ## @itemx pslatex
101 ## @itemx meta 102 ## @itemx meta
102 ## Microsoft Enhanced Metafile 103 ## Microsoft Enhanced Metafile
103 ## 104 ##
104 ## @item fig 105 ## @item fig
105 ## XFig. If this format is selected the additional options 106 ## XFig. If this format is selected the additional options
106 ## @option{-textspecial} or @option{-textnormal} can be used to control 107 ## @option{-textspecial} or @option{-textnormal} can be used to control
107 ## whether the special flag should be set for the text in 108 ## whether the special flag should be set for the text in
108 ## the figure (default is @option{-textnormal}). 109 ## the figure (default is @option{-textnormal}).
109 ## 110 ##
110 ## @item hpgl 111 ## @item hpgl
111 ## HP plotter language 112 ## HP plotter language
112 ## 113 ##
113 ## @item mf 114 ## @item mf
135 ## 136 ##
136 ## If the device is omitted, it is inferred from the file extension, 137 ## If the device is omitted, it is inferred from the file extension,
137 ## or if there is no filename it is sent to the printer as postscript. 138 ## or if there is no filename it is sent to the printer as postscript.
138 ## 139 ##
139 ## @item -d@var{ghostscript_device} 140 ## @item -d@var{ghostscript_device}
140 ## Additional devices are supported by Ghostscript. 141 ## Specify an output device supported by Ghostscript.
141 ## Some examples are; 142 ## Some examples are:
142 ## 143 ##
143 ## @table @code 144 ## @table @code
144 ## @item ljet2p 145 ## @item ljet2p
145 ## HP LaserJet IIP 146 ## HP LaserJet IIP
146 ## 147 ##
164 ## 165 ##
165 ## @item pdfwrite 166 ## @item pdfwrite
166 ## Converts ps or eps to pdf 167 ## Converts ps or eps to pdf
167 ## @end table 168 ## @end table
168 ## 169 ##
169 ## For a complete list, type `system ("gs -h")' to see what formats 170 ## For a complete list of available formats and devices type
170 ## and devices are available. 171 ## @samp{system ("gs -h")}.
171 ## 172 ##
172 ## When Ghostscript output is sent to a printer the size is determined 173 ## When Ghostscript output is sent to a printer the size is determined
173 ## by the figure's "papersize" property. When the output 174 ## by the figure's "papersize" property. When the output
174 ## is sent to a file the size is determined by the figure's 175 ## is sent to a file the size is determined by the figure's
175 ## "paperposition" property. 176 ## "paperposition" property.
176 ## 177 ##
177 ## @itemx -append 178 ## @item -append
178 ## Appends the output to a pre-existing file. Presently only PDF, 179 ## Append the output to a pre-existing file. Only PDF
179 ## and Postscript files are supported. 180 ## and Postscript files are currently supported.
180 ## 181 ##
181 ## @itemx -r@var{NUM} 182 ## @item -r@var{NUM}
182 ## Resolution of bitmaps in pixels per inch. For both metafiles and 183 ## Resolution of bitmaps in pixels per inch. For both metafiles and
183 ## SVG the default is the screen resolution, for other it is 150 dpi. 184 ## SVG the default is the screen resolution, for others it is 150 dpi.
184 ## To specify screen resolution, use "-r0". 185 ## To specify screen resolution, use "-r0".
185 ## 186 ##
186 ## @item -tight 187 ## @item -tight
187 ## Forces a tight bounding box for eps-files. Since the Ghostscript 188 ## Force a tight bounding box for eps-files. Because the Ghostscript
188 ## devices are conversions of an eps-file, this option works for those 189 ## devices are conversions of an eps-file, this option works for those
189 ## devices as well. 190 ## devices as well.
190 ## 191 ##
191 ## @itemx -S@var{xsize},@var{ysize} 192 ## @item -S@var{xsize},@var{ysize}
192 ## Plot size in pixels for EMF, GIF, JPEG, PBM, PNG and SVG@. If 193 ## Specify plot size in pixels for EMF, GIF, JPEG, PBM, PNG and SVG@. If
193 ## using the command form of the print function, you must quote the 194 ## using the command form of the print function, the @var{xsize},@var{ysize}
194 ## @var{xsize},@var{ysize} option. For example, by writing 195 ## option must be quoted. For example, by writing
195 ## @w{@code{"-S640,480"}}. The size defaults to that specified by the 196 ## @w{@code{"-S640,480"}}. The size defaults to that specified by the
196 ## figure's paperposition property. 197 ## figure's paperposition property.
197 ## 198 ##
198 ## @item -F@var{fontname} 199 ## @item -F@var{fontname}
199 ## @itemx -F@var{fontname}:@var{size} 200 ## @itemx -F@var{fontname}:@var{size}
200 ## @itemx -F:@var{size} 201 ## @itemx -F:@var{size}
201 ## @var{fontname} set the postscript font (for use with postscript, 202 ## Set the postscript font to @var{fontname} (for use with postscript,
202 ## aifm, @nospell{corel} and fig). By default, 'Helvetica' is set for PS/aifm, 203 ## aifm, @nospell{corel} and fig). By default, 'Helvetica' is set for PS/aifm,
203 ## and 'SwitzerlandLight' for Corel. It can also be 'Times-Roman'. 204 ## and 'SwitzerlandLight' for Corel. It can also be 'Times-Roman'.
204 ## @var{size} is given in points. @var{fontname} is ignored for the 205 ## @var{size} is given in points. @var{fontname} is ignored for the
205 ## fig device. 206 ## fig device.
206 ## @end table 207 ## @end table