.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "SAGA_CMD 1"
.TH SAGA_CMD 1 2024-02-09 9.3.1 " "
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
saga_cmd \- command\-line interface to the System for Automated Geoscientific Analyses
.SH SYNOPSIS
.IX Header "SYNOPSIS"
\&\fBsaga_cmd\fR [\fB\-d, \-\-docs\fR]
.PP
\&\fBsaga_cmd\fR [\fB\-b, \-\-batch\fR]
.PP
\&\fBsaga_cmd\fR [\fB\-h, \-\-help\fR]
.PP
\&\fBsaga_cmd\fR [\fB\-f, \-\-flags\fR][=qrsilpxo][\-s, \-\-story][=#][\-c, \-\-cores][=#] \fILIBRARY\fR [\fIMODULE\fR] <module specific options...>
.PP
\&\fBsaga_cmd\fR [\fB\-f, \-\-flags\fR][=qrsilpxo][\-s, \-\-story][=#][\-c, \-\-cores][=#] \fISCRIPT\fR
.SH DESCRIPTION
.IX Header "DESCRIPTION"
SAGA GIS (System for Automated Geoscientific Analysis) is a free and open source geographic information system used for editing and analysing spatial data. It includes a large number of modules for the analysis of vector, table, grid and image data.
.PP
The SAGA command line interpreter is particularly useful for the processing
of complex work flows by defining a series of subsequent tool calls in a
script file. Calling saga_cmd with the option '\fB\-b\fR' or '\fB\-\-batch\fR' will
create an example of a DOS batch script file, which might be a good starting
point for the implementation of your own specific work flows.
.PP
When run without arguments, the module libraries in the current module library are listed. By default this is the directory which was set at installtion (/usr/lib/saga). This can be overwritten by setting the environment variable \fISAGA_MLB\fR.
.SH OPTIONS
.IX Header "OPTIONS"
.IP [\fISAGA_MLB\fR=dirname] 8
.IX Item "[SAGA_MLB=dirname]"
Module libraries are expected to be located in the directory that is specified by the environment variable 'SAGA_MLB'. If this is not found the module installation directory (/usr/lib/saga) will be searched for instead.
.IP "\fILIBRARY\fR [\fIMODULE\fR] [\fIMODULE OPTIONS\fR]" 8
.IX Item "LIBRARY [MODULE] [MODULE OPTIONS]"
Specify the library (ie ta_morphometry) and the module (number or name). If no module is specified the different modules of a library are listed.
.IP "\fB\-h, \-\-help\fR" 8
.IX Item "-h, --help"
Display help and exit
.IP "\fB\-d, \-\-docs\fR" 8
.IX Item "-d, --docs"
Create tool documentation in the current working directory
.IP "\fB\-b, \-\-batch\fR" 8
.IX Item "-b, --batch"
Create batch file examples in the current working directory
.IP "\fB\-c, \-\-cores\fR" 8
.IX Item "-c, --cores"
Number of physical processors to use for computation
.IP "\fB\-f, \-\-flags\fR" 8
.IX Item "-f, --flags"
Various flags for general usage [qrsilpxo]
.RS 8
.IP "\fBq\fR No progress report" 9
.IX Item "q No progress report"
.PD 0
.IP "\fBr\fR No messages report" 9
.IX Item "r No messages report"
.IP "\fBs\fR Silent mode (no progress and no messages report)" 9
.IX Item "s Silent mode (no progress and no messages report)"
.IP "\fBi\fR Allow user interaction" 9
.IX Item "i Allow user interaction"
.IP "\fBl\fR Load translation dictionary" 9
.IX Item "l Load translation dictionary"
.IP "\fBp\fR Load projections dictionary" 9
.IX Item "p Load projections dictionary"
.IP "\fBx\fR Use XML markups for synopses and messages" 9
.IX Item "x Use XML markups for synopses and messages"
.IP "\fBo\fR Load old style naming" 9
.IX Item "o Load old style naming"
.RE
.RS 8
.RE
.PD
.SH EXAMPLE
.IX Header "EXAMPLE"
export SAGA_MLB=/usr/lib/saga
.PP
\&\fBsaga_cmd\fR ta_morphometry "Local Morphometry" \-ELEVATION dem.sgrd \-SLOPE slope.sgrd \-ASPECT aspect.sgrd \-METHOD 1
.PP
Multiple input files can be specified by separating them by a semicolon (;).
.PP
\&\fBsaga_cmd\fR libgrid_tools Merging \-GRIDS test1.sgrd\e;test2.sgrd \-GRID_TARGET merged.sgrd
.SH BUGS
.IX Header "BUGS"
On the website of \fIhttp://www.saga\-gis.org\fR, a list of known bugs can be found and new bug reports can be submitted.
.SH AUTHORS
.IX Header "AUTHORS"
\&\fBSAGA\fR was written by Olaf Conrad with help from a large number of contributors. This manual page was written by Johan Van de Wauw.
This manual is released under the GNU Lesser General Public License v2.1. The SAGA API uses the same license, however most of SAGA itself uses the GNU General Public License 2 or higher.
.PP
More info  \fIhttp://www.saga\-gis.org\fR
.PP
Please provide the following reference in your work if you are using SAGA:
.PP
Conrad, O., Bechtel, B., Bock, M., Dietrich, H., Fischer, E., Gerlitz, L.,
Wehberg, J., Wichmann, V., and Boehner, J. (2015):
System for Automated Geoscientific Analyses (SAGA) v. 2.1.4.
Geosci. Model Dev., 8, 1991\-2007, doi:10.5194/gmd\-8\-1991\-2015.
.PP
\&\fIhttp://www.geosci\-model\-dev.net/8/1991/2015/gmd\-8\-1991\-2015.html\fR