X-Git-Url: https://pintos-os.org/cgi-bin/gitweb.cgi?a=blobdiff_plain;f=doc%2Fconfiguring.texi;h=fc3d160b57b941a83c6312cc7d2b59e95d0f3ade;hb=cfbbebdd6b3085f4094c073e4ebd139ac1d37737;hp=b4aea100c3bb9f329ef2f063676afe537afc752f;hpb=00feff7775f55b3292d1f9461a79dde54b9eb2ba;p=pspp diff --git a/doc/configuring.texi b/doc/configuring.texi index b4aea100c3..fc3d160b57 100644 --- a/doc/configuring.texi +++ b/doc/configuring.texi @@ -11,7 +11,7 @@ This chapter describe how to configure PSPP for your system. * Configuration files:: How configuration files are read. * Environment variables:: All about environment variables. * Output devices:: Describing your terminal(s) and printer(s). -* PostScript driver class:: Configuration of PostScript devices. +* Cairo driver class:: Configuration of Cairo devices. * ASCII driver class:: Configuration of character-code devices. * HTML driver class:: Configuration for HTML output. * Miscellaneous configuring:: Even more configuration variables. @@ -208,7 +208,6 @@ The following sections further elaborate the contents of the * Macro definitions:: Environment variables local to @file{devices}. * Device definitions:: Output device descriptions. * Dimensions:: Lengths, widths, sizes, @enddots{} -* papersize:: Letter, legal, A4, envelope, @enddots{} * Distinguishing line types:: Details on @file{devices} parsing. * Tokenizing lines:: Dividing @file{devices} lines into tokens. @end menu @@ -325,7 +324,7 @@ A unique identifier, used to determine whether to enable the driver. @item class name One of the predefined driver classes supported by PSPP. The -currently supported driver classes include `postscript' and `ascii'. +currently supported driver classes include `cairo' and `ascii'. @item device type(s) Zero or more of the following keywords, delimited by spaces: @@ -444,36 +443,6 @@ Numbers 50 or greater are assumed to be in millimeters. @end itemize @end itemize -@node papersize -@subsection Paper sizes - -Output drivers usually deal with some sort of hardcopy media. This -media is called @dfn{paper} by the drivers, though in reality it could -be a transparency or film or thinly veiled sarcasm. To make it easier -for you to deal with paper, PSPP allows you to have (of course!) a -configuration file that gives symbolic names, like ``letter'' or -``legal'' or ``a4'', to paper sizes, rather than forcing you to use -cryptic numbers like ``8-1/2 x 11'' or ``210 by 297''. Surprisingly -enough, this configuration file is named @file{papersize}. -@xref{Configuration files}. - -When PSPP tries to connect a symbolic paper name to a paper size, it -reads and parses each non-comment line in the file, in order. The first -field on each line must be a symbolic paper name in double quotes. -Paper names may not contain double quotes. Paper names are not -case-sensitive: @samp{legal} and @samp{Legal} are equivalent. - -If a match is found for the paper name, the rest of the line is parsed. -If it is found to be a pair of dimensions (@pxref{Dimensions}) separated -by either @samp{x} or @samp{by}, then those are taken to be the paper -size, in order of width followed by length. There @emph{must} be at -least one space on each side of @samp{x} or @samp{by}. - -Otherwise the line must be of the form -@samp{"@var{paper-1}"="@var{paper-2}"}. In this case the target of the -search becomes paper name @var{paper-2} and the search through the file -continues. - @node Distinguishing line types @subsection How lines are divided into types @@ -571,37 +540,51 @@ interpreted; only the lower 8 bits are used. Tokens, outside of quoted strings, are delimited by white space or equals signs. -@node PostScript driver class -@section The PostScript driver class +@node Cairo driver class +@section The Cairo driver class + +The @code{cairo} driver class can produce output in PDF, PostScript, +and SVG formats. It has full support for international character +sets. -The @code{postscript} driver class is used to produce output that is -acceptable to PostScript printers and other interpreters. +The Cairo driver is only available if your copy of PSPP was built with +the Cairo library. The available options are listed below. @table @code @item output-file=@var{file-name} -File to which output should be sent. This can be an ordinary file name -(i.e., @code{"pspp.ps"}), a pipe (i.e., @code{"|lpr"}), or -stdout (@code{"-"}). Default: @code{"pspp.ps"}. +File to which output should be sent. Default: @code{"pspp.pdf"}. -@item headers=@var{boolean} +@item output-type=@var{output-type} -Controls whether the standard headers showing the time and date and -title and subtitle are printed at the top of each page. Default: -@code{on}. +Type of output to write to the output file, one of @code{pdf}, +@code{ps}, or @code{svg}. Default: @code{pdf}. @item paper-size=@var{paper-size} -Paper size, either as a symbolic name (i.e., @code{letter} or @code{a4}) -or specific measurements (i.e., @code{8-1/2x11} or @code{"210 x 297"}. -@xref{papersize, , Paper sizes}. Default: @code{letter}. +Paper size. You may specify a name (e.g.@: @code{a4}, @code{letter}) +or measurements (e.g.@: @code{210x297}, @code{8.5x11in}). + +The default paper size is taken from the @env{PAPERSIZE} environment +variable or the file indicated by the @env{PAPERCONF} environment +variable, if either variable is set. If not, and your system supports +the @code{LC_PAPER} locale category, then the default paper size is +taken from the locale. Otherwise, if @file{/etc/papersize} exists, +the default paper size is read from it. As a last resort, A4 paper is +assumed. @item orientation=@var{orientation} Either @code{portrait} or @code{landscape}. Default: @code{portrait}. +@item headers=@var{boolean} + +Controls whether the standard headers showing the time and date and +title and subtitle are printed at the top of each page. Default: +@code{on}. + @item left-margin=@var{dimension} @itemx right-margin=@var{dimension} @itemx top-margin=@var{dimension} @@ -611,29 +594,17 @@ Sets the margins around the page. The headers, if enabled, are not included in the margins; they are in addition to the margins. For a description of dimensions, see @ref{Dimensions}. Default: @code{0.5in}. -@item prop-font=@var{afm-file}[,@var{font-file}[,@var{encoding-file}]] -@itemx emph-font=@var{afm-file}[,@var{font-file}[,@var{encoding-file}]] -@itemx fixed-font=@var{afm-file}[,@var{font-file}[,@var{encoding-file}]] +@item prop-font=@var{font-name} +@itemx emph-font=@var{font-name} +@itemx fixed-font=@var{font-name} Sets the font used for proportional, emphasized, or fixed-pitch text. -The only required value is @var{afm-file}, the AFM file for the font. - -If specified, @var{font-file} will be downloaded to the printer at the -beginning of the print job. The font file may be in PFA or PFB format. - -The font is reencoded as specified in @var{encoding-file}, if specified. -Each line in @var{encoding-file} should consist of a PostScript -character name and a decimal encoding value (between 0 and 255), -separated by white space. Blank lines and comments introduced by -@samp{#} are also allowed. - -The files specified on these options are located as follows. If -the file name begins with @samp{/}, then it is taken as an absolute -path. Otherwise, PSPP searches its configuration path for the specified -name prefixed by @code{psfonts/} (@pxref{File locations}). +Most systems support CSS-like font names such as ``serif'' and +``monospace'', but a wide range of system-specific font are likely to +be supported as well. -Default: proportional font @code{Times-Roman.afm}, emphasis font -@code{Times-Italic.afm}, fixed-pitch font @code{Courier.afm}. +Default: proportional font @code{serif}, emphasis font @code{serif +italic}, fixed-pitch font @code{monospace}. @item font-size=@var{font-size} @@ -668,19 +639,26 @@ The available options are listed below. @item output-file=@var{file-name} File to which output should be sent. This can be an ordinary file name -(e.g., @code{"pspp.txt"}), a pipe (e.g., @code{"|lpr"}), or +(e.g., @code{"pspp.txt"}), a pipe (e.g., @code{"|more"}), or stdout (@code{"-"}). Default: @code{"pspp.list"}. +@item chart-files=@var{file-name-template} +Template for the file names used for charts. The name should contain +a single @samp{#}, which is replaced by the chart number. Default: +@file{"pspp-#.png"}. + +@item chart-type=@var{type}. +Type of charts to output, either @samp{png} or @samp{none}. +Default: @samp{png}. + +Charts are always disabled if your installation of PSPP was compiled +without the @code{cairo} library. + @item paginate=@var{boolean} If set, a formfeed will be written at the end of every page. Default: @code{on}. -@item tab-width=@var{tab-width-value} - -The distance between tab stops for this device. If set to 0, tabs will -not be used in the output. Default: @code{8}. - @item headers=@var{boolean} If enabled, two lines of header information giving title and subtitle, @@ -690,13 +668,17 @@ requested. Default: @code{on}. @item length=@var{line-count} -Physical length of a page, in lines. Headers and margins are subtracted -from this value. Default: @code{66}. +Physical length of a page. Headers and margins are subtracted from +this value. You may specify the number of lines as a number, or for +screen output you may specify @code{auto} to track the height of the +terminal as it changes. Default: @code{66}. @item width=@var{character-count} -Physical width of a page, in characters. Margins are subtracted from -this value. Default: @code{130}. +Physical width of a page. Margins are subtracted from this value. +You may specify the width as a number of characters, or for screen +output you may specify @code{auto} to track the width of the terminal +as it changes. Default: @code{79}. @item top-margin=@var{top-margin-lines} @@ -781,6 +763,11 @@ For all others, @samp{+} is used unless there are double lines or special lines, in which case @samp{#} is used. @end itemize +@item init=@var{init-string} +If set, this string is written at the beginning of each output file. +It can be used to initialize device features, e.g.@: to enable VT100 +line-drawing characters. + @item emphasis=@var{emphasis-style} How to emphasize text. Your choices are @code{bold}, @code{underline}, @@ -878,15 +865,10 @@ support was compiled into PSPP. The basename used to search for the driver definition file. @xref{Output devices}. @xref{File locations}. Default: @code{devices}. -@item STAT_OUTPUT_PAPERSIZE_FILE - -The basename used to search for the papersize file. @xref{papersize}. -@xref{File locations}. Default: @code{papersize}. - @item STAT_OUTPUT_INIT_PATH -The path used to search for the driver definition file and the papersize -file. @xref{File locations}. Default: the standard configuration path. +The path used to search for the driver definition file. +@xref{File locations}. Default: the standard configuration path. @item TMPDIR