X-Git-Url: https://pintos-os.org/cgi-bin/gitweb.cgi?a=blobdiff_plain;f=doc%2Finvoking.texi;h=3052162fddbfac4af381b3e3e1966c7f3e0704f8;hb=HEAD;hp=15b047b8b1031d5f7fb193ac119dc7ceb564212d;hpb=00feff7775f55b3292d1f9461a79dde54b9eb2ba;p=pspp-builds.git diff --git a/doc/invoking.texi b/doc/invoking.texi index 15b047b8..3052162f 100644 --- a/doc/invoking.texi +++ b/doc/invoking.texi @@ -1,18 +1,46 @@ @node Invocation -@chapter Invoking PSPP + +@chapter Starting PSPP @cindex invocation @cindex PSPP, invoking +There are two separate user interfaces for PSPP. +There is the command line interface, which responds to commands +typed by the user. +The command line interface is generally available on more platforms +than the graphic user interface and since it doesn't require a +graphics device it can be used from a remote terminal. +Platforms which have a windowing system may also be able to support +the graphic user interface. +The graphic user interface can perform all functionality of the +command line interface. +In addition it gives an instantaneous view of the data, variables and +statistical output. + +Whichever interface you choose, a basic understanding of the concepts +used by PSPP is necessary before effective use of the system can be achieved. + + +@menu +* The command line user interface:: +* The graphic user interface:: +@end menu + + +@node The command line user interface +@section The command line user interface + @cindex command line, options @cindex options, command-line + @example pspp [ -B @var{dir} | --config-dir=@var{dir} ] [ -o @var{device} | --device=@var{device} ] - [ -d @var{var}[=@var{value}] | --define=@var{var}[=@var{value}] ] [-u @var{var} | --undef=@var{var} ] - [ -f @var{file} | --out-file=@var{file} ] [ -p | --pipe ] [ -I- | --no-include ] + [ -a @{compatible|enhanced@} | --algorithm=@{compatible|enhanced@}] + [ -x @{compatible|enhanced@} | --syntax=@{compatible|enhanced@}] + [ -I- | --no-include ] [ -I @var{dir} | --include=@var{dir} ] [ -i | --interactive ] - [ -n | --edit | --dry-run | --just-print | --recon ] [ -r | --no-statrc ] [ -h | --help ] [ -l | --list ] - [ -c @var{command} | --command @var{command} ] [ -s | --safer ] + [ -s | --safer ] [ --testing-mode ] [ -V | --version ] [ -v | --verbose ] [ @var{key}=@var{value} ] @var{file}@enddots{} @end example @@ -26,7 +54,7 @@ pspp [ -B @var{dir} | --config-dir=@var{dir} ] [ -o @var{device} | --device=@var @end menu @node Non-option Arguments -@section Non-option Arguments +@subsection Non-option Arguments Syntax files and output device substitutions can be specified on PSPP's command line: @@ -35,7 +63,7 @@ PSPP's command line: @item @var{file} A file by itself on the command line will be executed as a syntax file. -If multiple files may be specified, they are executed in order, as if +If multiple files are specified, they are executed in order, as if their contents had been given in a single file. PSPP terminates after the syntax files run, unless the @code{-i} or @code{--interactive} option is given (@pxref{Language control options}). @@ -64,7 +92,7 @@ typing its name. You can include any options on the command line as usual. PSPP entirely ignores any lines beginning with @samp{#!}. @node Configuration Options -@section Configuration Options +@subsection Configuration Options Configuration options are used to change PSPP's configuration for the current run. The configuration options are: @@ -95,25 +123,12 @@ option disables all devices besides those mentioned on the command line. @end table @node Input and output options -@section Input and output options +@subsection Input and output options Input and output options affect how PSPP reads input and writes output. These are the input and output options: @table @code -@item -f @var{file} -@itemx --out-file=@var{file} - -This overrides the output file name for devices designated as listing -devices. If a file named @var{file} already exists, it is overwritten. - -@item -p -@itemx --pipe - -Allows PSPP to be used as a filter by causing the syntax file to be -read from stdin and output to be written to stdout. Conflicts with the -@code{-f @var{file}} and @code{--file=@var{file}} options. - @item -I- @itemx --no-include @@ -127,12 +142,6 @@ configuring}. Appends directory @var{dir} to the path that is searched for include files in PSPP syntax files. -@item -c @var{command} -@itemx --command=@var{command} - -Execute literal command @var{command}. The command is executed before -startup syntax files, if any. - @item --testing-mode Invoke heuristics to assist with testing PSPP. For use by @code{make @@ -140,7 +149,7 @@ check} and similar scripts. @end table @node Language control options -@section Language control options +@subsection Language control options Language control options control how PSPP syntax files are parsed and interpreted. The available language control options are: @@ -158,16 +167,6 @@ mode, rather than the default batch mode. @xref{Tokenizing lines}, for information on the differences between batch mode and interactive mode command interpretation. -@item -n -@itemx --edit -@itemx --dry-run -@itemx --just-print -@itemx --recon - -Only the syntax of any syntax file specified or of commands entered at -the command line is checked. Transformations are not performed and -procedures are not executed. Not yet implemented. - @item -r @itemx --no-statrc @@ -181,7 +180,7 @@ HOST commands, as well as use of pipes as input and output files. @end table @node Informational options -@section Informational options +@subsection Informational options Informational options cause information about PSPP to be written to the terminal. Here are the available options: @@ -253,4 +252,19 @@ Individual directories included in file searches. Each verbosity level also includes messages from lower verbosity levels. @end table -@setfilename ignored + + +@node The graphic user interface +@section The graphic user interface + +@cindex Graphic user interface +@cindex PSPPIRE + +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 +from which @command{psppire} can be started by a series of mouse clicks. + +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.