X-Git-Url: https://pintos-os.org/cgi-bin/gitweb.cgi?a=blobdiff_plain;f=doc%2Fconfiguring.texi;h=164d9ab1aac182a38c04120ef1028e8fb30684aa;hb=HEAD;hp=833840b31ff388af1c513ef40a5843b29de80347;hpb=44326932c8227c64a87f7a92ef16ce83c2fba2d4;p=pspp-builds.git diff --git a/doc/configuring.texi b/doc/configuring.texi index 833840b3..164d9ab1 100644 --- a/doc/configuring.texi +++ b/doc/configuring.texi @@ -1,4 +1,4 @@ -@node Configuration, Portable File Format, Concept Index, Top +@node Configuration @appendix Configuring PSPP @cindex configuration @cindex PSPP, configuring @@ -17,7 +17,7 @@ This chapter describe how to configure PSPP for your system. * Miscellaneous configuring:: Even more configuration variables. @end menu -@node File locations, Configuration techniques, Configuration, Configuration +@node File locations @section Locating configuration files PSPP searches each directory in the configuration file path for most @@ -29,7 +29,7 @@ default path. Finally, @samp{-B @var{path}} or @samp{--config-dir=@var{path}} specified on the command line has highest priority. -@node Configuration techniques, Configuration files, File locations, Configuration +@node Configuration techniques @section Configuration techniques There are many ways that PSPP can be configured. These are @@ -59,7 +59,7 @@ Fallback defaults. Some of the above may not apply to a particular setting. -@node Configuration files, Environment variables, Configuration techniques, Configuration +@node Configuration files @section Configuration files Most configuration files have a common form: @@ -113,7 +113,7 @@ Line splicing takes place before comment removal. Blank lines, and lines that contain only white space, are ignored. @end itemize -@node Environment variables, Output devices, Configuration files, Configuration +@node Environment variables @section Environment variables You may think the concept of environment variables is a fairly simple @@ -126,7 +126,7 @@ in the sections below: * Predefined variables:: A few variables are automatically defined. @end menu -@node Environment substitutions, Predefined variables, Environment variables, Environment variables +@node Environment substitutions @subsection Environment substitutions Much of the power of environment variables lies in the way that they may @@ -154,7 +154,7 @@ Replaced by a single dollar sign. Undefined variables expand to a empty value. -@node Predefined variables, , Environment substitutions, Environment variables +@node Predefined variables @subsection Predefined environment variables There are two environment variables predefined for use in environment @@ -175,7 +175,7 @@ somewhat dependent on the system used to compile PSPP. Nothing prevents these values from being overridden, although it's a good idea not to do so. -@node Output devices, PostScript driver class, Environment variables, Configuration +@node Output devices @section Output devices Configuring output devices is the most complicated aspect of configuring @@ -193,7 +193,7 @@ briefly in the table below: Define a driver in terms of other drivers. @item macro definitions -Define environment variables local to the the output driver +Define environment variables local to the output driver configuration file. @item device definitions @@ -208,12 +208,11 @@ 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 -@node Driver categories, Macro definitions, Output devices, Output devices +@node Driver categories @subsection Driver categories Drivers can be divided into categories. Drivers are specified by their @@ -258,7 +257,7 @@ is not enabled. It is an error if the list is not empty when the end of @file{devices} is reached. -@node Macro definitions, Device definitions, Driver categories, Output devices +@node Macro definitions @subsection Macro definitions Macro definitions take the form @samp{define @var{macroname} @@ -306,7 +305,7 @@ Defined as the length of the console screen, in lines of text. @end table @end itemize -@node Device definitions, Dimensions, Macro definitions, Output devices +@node Device definitions @subsection Driver definitions Driver definitions are the ultimate purpose of the @file{devices} @@ -381,7 +380,7 @@ available driver classes. Options are dependent on the driver. See the driver descriptions for details. -@node Dimensions, papersize, Device definitions, Output devices +@node Dimensions @subsection Dimensions Quite often in configuration it is necessary to specify a length or a @@ -444,37 +443,7 @@ Numbers 50 or greater are assumed to be in millimeters. @end itemize @end itemize -@node papersize, Distinguishing line types, Dimensions, Output devices -@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, Tokenizing lines, papersize, Output devices +@node Distinguishing line types @subsection How lines are divided into types The lines in @file{devices} are distinguished in the following manner: @@ -504,7 +473,7 @@ macro definition. Otherwise, the line is ill-formed. @end enumerate -@node Tokenizing lines, , Distinguishing line types, Output devices +@node Tokenizing lines @subsection How lines are divided into tokens Each driver definition line is run through a simple tokenizer. This @@ -571,7 +540,7 @@ 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, ASCII driver class, Output devices, Configuration +@node PostScript driver class @section The PostScript driver class The @code{postscript} driver class is used to produce output that is @@ -594,9 +563,16 @@ title and subtitle are printed at the top of each page. Default: @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} @@ -655,7 +631,7 @@ Default: @code{1pt}. Sets the width of the lines used in tables. Default: @code{0.5pt}. @end table -@node ASCII driver class, HTML driver class, PostScript driver class, Configuration +@node ASCII driver class @section The ASCII driver class The ASCII driver class produces output that can be displayed on a @@ -668,9 +644,24 @@ 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. Available types typically include @samp{X}, +@samp{png}, @samp{gif}, @samp{svg}, @samp{ps}, @samp{cgm}, @samp{fig}, +@samp{pcl}, @samp{hpgl}, @samp{regis}, @samp{tek}, and @samp{meta}. +Default: @samp{png}. + +You may specify @samp{none} to disable chart output. Charts are also +disabled if your installation of PSPP was compiled without +@code{libplot}. + @item paginate=@var{boolean} If set, a formfeed will be written at the end of every page. Default: @@ -690,13 +681,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 +776,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}, @@ -789,7 +789,7 @@ overstriking, which may not be supported by all the software to which you might pass the output. @end table -@node HTML driver class, Miscellaneous configuring, ASCII driver class, Configuration +@node HTML driver class @section The HTML driver class The @code{html} driver class is used to produce output for viewing in @@ -812,7 +812,7 @@ format. The name should contain a single @samp{#}, which is replaced by the chart number. Default: @file{"pspp-#.png"}. @end table -@node Miscellaneous configuring,, HTML driver class, Configuration +@node Miscellaneous configuring @section Miscellaneous configuration The following environment variables can be used to further configure @@ -878,15 +878,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