X-Git-Url: https://pintos-os.org/cgi-bin/gitweb.cgi?a=blobdiff_plain;f=doc%2Finvoking.texi;h=b1a299720f246a519d98676e048811f3d884916f;hb=514d9af1f690c316a5ad501aa0083ba6c1e00e56;hp=039a2ad4aa032bc42ee6655676344e69ef24ce66;hpb=41a628f070c7a0d2e9468308cb1bf4ff77de9900;p=pspp diff --git a/doc/invoking.texi b/doc/invoking.texi index 039a2ad4aa..b1a299720f 100644 --- a/doc/invoking.texi +++ b/doc/invoking.texi @@ -1,3 +1,12 @@ +@c PSPP - a program for statistical analysis. +@c Copyright (C) 2017 Free Software Foundation, Inc. +@c Permission is granted to copy, distribute and/or modify this document +@c under the terms of the GNU Free Documentation License, Version 1.3 +@c or any later version published by the Free Software Foundation; +@c with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. +@c A copy of the license is included in the section entitled "GNU +@c Free Documentation License". +@c @node Invoking PSPP @chapter Invoking @command{pspp} @cindex invocation @@ -12,12 +21,12 @@ The sections below describe the @command{pspp} program's command-line interface. @menu -* Main Options:: -* PDF PostScript and SVG Output Options:: -* Plain Text Output Options:: -* HTML Output Options:: -* OpenDocument Output Options:: -* Comma-Separated Value Output Options:: +* Main Options:: +* PDF PostScript and SVG Output Options:: +* Plain Text Output Options:: +* HTML Output Options:: +* OpenDocument Output Options:: +* Comma-Separated Value Output Options:: @end menu @node Main Options @@ -98,7 +107,7 @@ A few options that apply generically are listed below. @item @option{-O format=@var{format}} @pspp{} uses the extension of the file name given on @option{-o} to select an output format. Use this option to override this choice by -specifying an alternate format, e.g.@: @option{-o pspp.out -O html} to +specifying an alternate format, e.g.@: @option{-o pspp.out -O format=html} to write HTML to a file named @file{pspp.out}. Use @option{--help} to list the available formats. @@ -148,7 +157,9 @@ interactive mode, respectively, rather than the default ``auto'' mode. @item @option{-r} @itemx @option{--no-statrc} -Disables running @file{rc} at @pspp{} startup time. +By default, at startup @pspp{} searches for a file named @file{rc} in +the include path (described above) and, if it finds one, runs the +commands in it. This option disables this behavior. @item @option{-a @{enhanced|compatible@}} @itemx @option{--algorithm=@{enhanced|compatible@}} @@ -302,39 +313,23 @@ Specify @code{none} to disable chart output. Charts are always disabled if your installation of @pspp{} was compiled without the Cairo library. -@item @option{-O paginate=@var{boolean}} -If set, @pspp{} writes an ASCII formfeed the end of every page. Default: -@code{off}. - -@item @option{-O headers=@var{boolean}} -If enabled, @pspp{} prints two lines of header information giving title -and subtitle, page number, date and time, and @pspp{} version are printed -at the top of every page. These two lines are in addition to any top -margin requested. Default: @code{off}. - -@item @option{-O length=@var{line-count}} -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 @option{-O width=@var{character-count}} -Width of a page, in characters. Margins are subtracted from this -value. For screen output you may specify @code{auto} in place of a -number to track the width of the terminal as it changes. Default: -@code{79}. - -@item @option{-O top-margin=@var{top-margin-lines}} -Length of the top margin, in lines. @pspp{} subtracts this value from -the page length. Default: @code{0}. +@item @option{-O foreground-color=@var{color}} +@itemx @option{-O background-color=@var{color}} +Sets @var{color} as the color to be used for the background or foreground to +be used for charts. +Color should be given in the format @code{#@var{RRRR}@var{GGGG}@var{BBBB}}, +where @var{RRRR}, @var{GGGG} and @var{BBBB} are 4 character hexadecimal +representations of the red, green and blue components respectively. +If charts are disabled, this option has no effect. -@item @option{-O bottom-margin=@var{bottom-margin-lines}} -Length of the bottom margin, in lines. @pspp{} subtracts this value from -the page length. Default: @code{0}. +@item @option{-O width=@var{columns}} +Width of a page, in columns. If unspecified or given as @code{auto}, +the default is the width of the terminal, for interactive output, or +the WIDTH setting (@pxref{SET}), for output to a file. @item @option{-O box=@{ascii|unicode@}} -Sets the characters used for lines in tables. -If set to +Sets the characters used for lines in tables. +If set to @code{ascii} the characters @samp{-}, @samp{|}, and @samp{+} for single-width lines and @samp{=} and @samp{#} for double-width lines are used. If set to @code{unicode} then Unicode box drawing characters will be used. @@ -411,8 +406,13 @@ character itself. If @var{qualifier} is longer than one character, only the first character is used; if @var{qualifier} is the empty string, then fields are never quoted. +@item @option{-O titles=@var{boolean}} +Whether table titles (brief descriptions) should be printed. Default: +@code{on}. + @item @option{-O captions=@var{boolean}} -Whether table captions should be printed. Default: @code{on}. +Whether table captions (more extensive descriptions) should be +printed. Default: on. @end table The CSV format used is an extension to that specified in RFC 4180: @@ -422,9 +422,24 @@ The CSV format used is an extension to that specified in RFC 4180: Each table row is output on a separate line, and each column is output as a field. The contents of a cell that spans multiple rows or columns is output only for the top-left row and column; the rest are -output as empty fields. When a table has a caption and captions are -enabled, the caption is output just above the table as a single field -prefixed by @samp{Table:}. +output as empty fields. + +@item Titles +When a table has a title and titles are enabled, the title is output +just above the table as a single field prefixed by @samp{Table:}. + +@item Captions +When a table has a caption and captions are enabled, the caption is +output just below the table as a single field prefixed by +@samp{Caption:}. + +@item Footnotes +Within a table, footnote markers are output as bracketed letters +following the cell's contents, e.g.@tie{}@samp{[a]}, @samp{[b]}, +@enddots{} The footnotes themselves are output following the body of +the table, as a separate two-column table introduced with a line that +says @samp{Footnotes:}. Each row in the table represent one footnote: +the first column is the marker, the second column is the text. @item Text Text in output is printed as a field on a line by itself. The TITLE @@ -450,11 +465,11 @@ The PSPPIRE graphic user interface for @pspp{} can perform all functionality of the command line interface. In addition it gives an instantaneous view of the data, variables and statistical output. -The graphic user interface can be started by typing @command{psppire} at a +The graphic user interface can be started by typing @command{psppire} at a command prompt. -Alternatively many systems have a system of interactive menus or buttons +Alternatively many systems have a system of interactive menus or buttons from which @command{psppire} can be started by a series of mouse clicks. -Once the principles of the @pspp{} system are understood, +Once the principles of the @pspp{} system are understood, the graphic user interface is designed to be largely intuitive, and for this reason is covered only very briefly by this manual.