File: saga_cmd.1

package info (click to toggle)
saga 2.3.1%2Bdfsg-3
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 32,000 kB
  • ctags: 23,638
  • sloc: cpp: 271,620; ansic: 9,209; sh: 4,232; makefile: 2,670; xml: 1,978; python: 1,000; pascal: 279
file content (227 lines) | stat: -rwxr-xr-x 8,106 bytes parent folder | download | duplicates (4)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.28)
.\"
.\" 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
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    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 turned on, 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
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "SAGA_CMD 1"
.TH SAGA_CMD 1 "2014-11-03" "2.1.3" " "
.\" 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][=#] \fI\s-1LIBRARY\s0\fR [\fI\s-1MODULE\s0\fR] <module specific options...>
.PP
\&\fBsaga_cmd\fR [\fB\-f, \-\-flags\fR][=qrsilpxo][\-s, \-\-story][=#][\-c, \-\-cores][=#] \fI\s-1SCRIPT\s0\fR
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
\&\s-1SAGA GIS \s0(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 \s-1SAGA\s0 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 \s-1DOS\s0 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 \fI\s-1SAGA_MLB\s0\fR.
.SH "OPTIONS"
.IX Header "OPTIONS"
.IP "[\fI\s-1SAGA_MLB\s0\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 '\s-1SAGA_MLB\s0'. If this is not found the module installation directory (/usr/lib/saga) will be searched for instead.
.IP "\fI\s-1LIBRARY\s0\fR [\fI\s-1MODULE\s0\fR] [\fI\s-1MODULE OPTIONS\s0\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 \s-1XML\s0 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 \*(L"Local Morphometry\*(R" \-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"
\&\fB\s-1SAGA\s0\fR was written by Olaf Conrad with help from a large number of contributors. This manual page was written by Johan Van de Wauw.
Both are released under the \s-1GNU\s0 General Public License v2.
.PP
More info  \fIhttp://www.saga\-gis.org\fR