Mercurial > octave

comparison scripts/plot/util/print.m @ 20173:777f26aa8e3e stable

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc: Update more docstrings to have one sentence summary as first line. Reviewed plot/ and gui/ in scripts directory. * scripts/gui/errordlg.m, scripts/gui/helpdlg.m, scripts/gui/inputdlg.m, scripts/gui/listdlg.m, scripts/gui/msgbox.m, scripts/gui/private/__get_funcname__.m, scripts/gui/private/__uiobject_split_args__.m, scripts/gui/questdlg.m, scripts/gui/uigetdir.m, scripts/gui/uigetfile.m, scripts/gui/uiwait.m, scripts/gui/waitbar.m, scripts/gui/warndlg.m, scripts/plot/appearance/annotation.m, scripts/plot/appearance/axis.m, scripts/plot/appearance/box.m, scripts/plot/appearance/caxis.m, scripts/plot/appearance/datetick.m, scripts/plot/appearance/hidden.m, scripts/plot/appearance/legend.m, scripts/plot/appearance/xlim.m, scripts/plot/appearance/ylim.m, scripts/plot/appearance/zlim.m, scripts/plot/draw/area.m, scripts/plot/draw/comet.m, scripts/plot/draw/comet3.m, scripts/plot/draw/contour.m, scripts/plot/draw/contourf.m, scripts/plot/draw/isocolors.m, scripts/plot/draw/isonormals.m, scripts/plot/draw/isosurface.m, scripts/plot/draw/plotmatrix.m, scripts/plot/draw/quiver.m, scripts/plot/draw/quiver3.m, scripts/plot/draw/ribbon.m, scripts/plot/draw/semilogxerr.m, scripts/plot/draw/semilogyerr.m, scripts/plot/draw/sphere.m, scripts/plot/draw/surfl.m, scripts/plot/draw/tetramesh.m, scripts/plot/util/allchild.m, scripts/plot/util/ancestor.m, scripts/plot/util/axes.m, scripts/plot/util/colstyle.m, scripts/plot/util/frame2im.m, scripts/plot/util/gnuplot_binary.in, scripts/plot/util/hgsave.m, scripts/plot/util/im2frame.m, scripts/plot/util/isaxes.m, scripts/plot/util/isfigure.m, scripts/plot/util/linkaxes.m, scripts/plot/util/ndgrid.m, scripts/plot/util/pan.m, scripts/plot/util/print.m, scripts/plot/util/printd.m, scripts/plot/util/private/__add_default_menu__.m, scripts/plot/util/rotate.m, scripts/plot/util/rotate3d.m, scripts/plot/util/saveas.m, scripts/plot/util/struct2hdl.m, scripts/plot/util/subplot.m, scripts/plot/util/zoom.m: Update more docstrings to have one sentence summary as first line.
author Rik <rik@octave.org>
date Sat, 09 May 2015 22:50:09 -0700
parents 9a2d8b1f931e
children aa36fb998a4d
comparison
equal deleted inserted replaced
20172:4f45eaf83908 20173:777f26aa8e3e
24 ## Print a plot, or save it to a file. 24 ## Print a plot, or save it to a file.
25 ## 25 ##
26 ## Both output formatted for printing (PDF and PostScript), and many bitmapped 26 ## Both output formatted for printing (PDF and PostScript), and many bitmapped
27 ## and vector image formats are supported. 27 ## and vector image formats are supported.
28 ## 28 ##
29 ## @var{filename} defines the name of the output file. If the 29 ## @var{filename} defines the name of the output file. If the file name has
30 ## file name has no suffix, one is inferred from the specified 30 ## no suffix, one is inferred from the specified device and appended to the
31 ## device and appended to the file name. If no filename is 31 ## file name. If no filename is specified, the output is sent to the
32 ## specified, the output is sent to the printer. 32 ## printer.
33 ## 33 ##
34 ## @var{h} specifies the handle of the figure to print. If no handle is 34 ## @var{h} specifies the handle of the figure to print. If no handle is
35 ## specified the current figure is used. 35 ## specified the current figure is used.
36 ## 36 ##
37 ## For output to a printer, PostScript file, or PDF file, 37 ## For output to a printer, PostScript file, or PDF file, the paper size is
38 ## the paper size is specified by the figure's @code{papersize} 38 ## specified by the figure's @code{papersize} property. The location and
39 ## property. The location and size of the image on the page are 39 ## size of the image on the page are specified by the figure's
40 ## specified by the figure's @code{paperposition} property. The 40 ## @code{paperposition} property. The orientation of the page is specified
41 ## orientation of the page is specified by the figure's 41 ## by the figure's @code{paperorientation} property.
42 ## @code{paperorientation} property.
43 ## 42 ##
44 ## The width and height of images are specified by the figure's 43 ## The width and height of images are specified by the figure's
45 ## @code{paperpositon(3:4)} property values. 44 ## @code{paperpositon(3:4)} property values.
46 ## 45 ##
47 ## The @code{print} command supports many @var{options}: 46 ## The @code{print} command supports many @var{options}:
48 ## 47 ##
49 ## @table @code 48 ## @table @code
50 ## @item -f@var{h} 49 ## @item -f@var{h}
51 ## Specify the handle, @var{h}, of the figure to be printed. The 50 ## Specify the handle, @var{h}, of the figure to be printed. The default
52 ## default is the current figure. 51 ## is the current figure.
53 ## 52 ##
54 ## @item -P@var{printer} 53 ## @item -P@var{printer}
55 ## Set the @var{printer} name to which the plot is sent if no 54 ## Set the @var{printer} name to which the plot is sent if no
56 ## @var{filename} is specified. 55 ## @var{filename} is specified.
57 ## 56 ##
58 ## @item -G@var{ghostscript_command} 57 ## @item -G@var{ghostscript_command}
59 ## Specify the command for calling Ghostscript. For Unix and Windows 58 ## Specify the command for calling Ghostscript. For Unix and Windows the
60 ## the defaults are @qcode{"gs"} and @qcode{"gswin32c"}, respectively. 59 ## defaults are @qcode{"gs"} and @qcode{"gswin32c"}, respectively.
61 ## 60 ##
62 ## @item -color 61 ## @item -color
63 ## @itemx -mono 62 ## @itemx -mono
64 ## Color or monochrome output. 63 ## Color or monochrome output.
65 ## 64 ##
67 ## @itemx -dashed 66 ## @itemx -dashed
68 ## Force all lines to be solid or dashed, respectively. 67 ## Force all lines to be solid or dashed, respectively.
69 ## 68 ##
70 ## @item -portrait 69 ## @item -portrait
71 ## @itemx -landscape 70 ## @itemx -landscape
72 ## Specify the orientation of the plot for printed output. For 71 ## Specify the orientation of the plot for printed output.
73 ## non-printed output the aspect ratio of the output corresponds to 72 ## For non-printed output the aspect ratio of the output corresponds to the
74 ## the plot area defined by the @qcode{"paperposition"} property in the 73 ## plot area defined by the @qcode{"paperposition"} property in the
75 ## orientation specified. This option is equivalent to changing 74 ## orientation specified. This option is equivalent to changing the figure's
76 ## the figure's @qcode{"paperorientation"} property. 75 ## @qcode{"paperorientation"} property.
77 ## 76 ##
78 ## @item -TextAlphaBits=@var{n} 77 ## @item -TextAlphaBits=@var{n}
79 ## @itemx -GraphicsAlphaBits=@var{n} 78 ## @itemx -GraphicsAlphaBits=@var{n}
80 ## Octave is able to produce output for various printers, bitmaps, and 79 ## Octave is able to produce output for various printers, bitmaps, and
81 ## vector formats by using Ghostscript. 80 ## vector formats by using Ghostscript. For bitmap and printer output
82 ## For bitmap and printer output anti-aliasing is applied using 81 ## anti-aliasing is applied using Ghostscript's TextAlphaBits and
83 ## Ghostscript's TextAlphaBits and GraphicsAlphaBits options. 82 ## GraphicsAlphaBits options. The default number of bits for each is 4.
84 ## The default number of bits for each is 4.
85 ## Allowed values for @var{N} are 1, 2, or 4. 83 ## Allowed values for @var{N} are 1, 2, or 4.
86 ## 84 ##
87 ## @item -d@var{device} 85 ## @item -d@var{device}
88 ## The available output format is specified by the option @var{device}, 86 ## The available output format is specified by the option @var{device}, and
89 ## and is one of: 87 ## is one of:
90 ## 88 ##
91 ## @table @code 89 ## @table @code
92 ## @item ps 90 ## @item ps
93 ## @itemx ps2 91 ## @itemx ps2
94 ## @itemx psc 92 ## @itemx psc
146 ## @itemx meta 144 ## @itemx meta
147 ## Microsoft Enhanced Metafile 145 ## Microsoft Enhanced Metafile
148 ## 146 ##
149 ## @item fig 147 ## @item fig
150 ## XFig. For the Gnuplot graphics toolkit, the additional options 148 ## XFig. For the Gnuplot graphics toolkit, the additional options
151 ## @option{-textspecial} or @option{-textnormal} can be used to control 149 ## @option{-textspecial} or @option{-textnormal} can be used to control whether the special flag should be set for the text in the figure. (default is @option{-textnormal})
152 ## whether the special flag should be set for the text in
153 ## the figure. (default is @option{-textnormal})
154 ## 150 ##
155 ## @item hpgl 151 ## @item hpgl
156 ## HP plotter language 152 ## HP plotter language
157 ## 153 ##
158 ## @item mf 154 ## @item mf
200 ## @end table 196 ## @end table
201 ## 197 ##
202 ## For a complete list, type @code{system ("gs -h")} to see what formats 198 ## For a complete list, type @code{system ("gs -h")} to see what formats
203 ## and devices are available. 199 ## and devices are available.
204 ## 200 ##
205 ## When Ghostscript output is sent to a printer the size is determined 201 ## When Ghostscript output is sent to a printer the size is determined by
206 ## by the figure's @qcode{"papersize"} property. When the output 202 ## the figure's @qcode{"papersize"} property. When the output is sent to a
207 ## is sent to a file the size is determined by the plot box defined by 203 ## file the size is determined by the plot box defined by the figure's
208 ## the figure's @qcode{"paperposition"} property. 204 ## @qcode{"paperposition"} property.
209 ## 205 ##
210 ## @item -append 206 ## @item -append
211 ## Append PostScript or PDF output to a pre-existing file of the same type. 207 ## Append PostScript or PDF output to a pre-existing file of the same type.
212 ## 208 ##
213 ## @item -r@var{NUM} 209 ## @item -r@var{NUM}
214 ## Resolution of bitmaps in pixels per inch. For both metafiles and 210 ## Resolution of bitmaps in pixels per inch. For both metafiles and SVG
215 ## SVG the default is the screen resolution; for other formats it is 150 dpi. 211 ## the default is the screen resolution; for other formats it is 150 dpi. To
216 ## To specify screen resolution, use @qcode{"-r0"}. 212 ## specify screen resolution, use @qcode{"-r0"}.
217 ## 213 ##
218 ## @item -loose 214 ## @item -loose
219 ## @itemx -tight 215 ## @itemx -tight
220 ## Force a tight or loose bounding box for eps files. The default is loose. 216 ## Force a tight or loose bounding box for eps files. The default is loose.
221 ## 217 ##
235 ## @item -tiff 231 ## @item -tiff
236 ## Provide a tiff preview. 232 ## Provide a tiff preview.
237 ## @end table 233 ## @end table
238 ## 234 ##
239 ## @item -S@var{xsize},@var{ysize} 235 ## @item -S@var{xsize},@var{ysize}
240 ## Plot size in pixels for EMF, GIF, JPEG, PBM, PNG, and SVG@. For 236 ## Plot size in pixels for EMF, GIF, JPEG, PBM, PNG, and SVG@.
241 ## PS, EPS, PDF, and other vector formats the plot size is in points. 237 ## For PS, EPS, PDF, and other vector formats the plot size is in points.
242 ## This option is equivalent to changing the size of the plot box 238 ## This option is equivalent to changing the size of the plot box associated
243 ## associated with the @qcode{"paperposition"} property. When using the 239 ## with the @qcode{"paperposition"} property. When using the command form of
244 ## command form of the print function you must quote the 240 ## the print function you must quote the @var{xsize},@var{ysize} option. For
245 ## @var{xsize},@var{ysize} option. For example, by writing @w{"-S640,480"}. 241 ## example, by writing @w{"-S640,480"}.
246 ## 242 ##
247 ## @item -F@var{fontname} 243 ## @item -F@var{fontname}
248 ## @itemx -F@var{fontname}:@var{size} 244 ## @itemx -F@var{fontname}:@var{size}
249 ## @itemx -F:@var{size} 245 ## @itemx -F:@var{size}
250 ## Use @var{fontname} and/or @var{fontsize} for all text. 246 ## Use @var{fontname} and/or @var{fontsize} for all text.