[saga] 10/11: Further changes saga_cmd manfile

Johan Van de Wauw johanvdw-guest at moszumanska.debian.org
Mon Nov 3 19:43:42 UTC 2014


This is an automated email from the git hooks/post-receive script.

johanvdw-guest pushed a commit to branch experimental
in repository saga.

commit 02d05becc4d085f16896937e2682ba66efa52bae
Author: Johan Van de Wauw <johan.vandewauw at gmail.com>
Date:   Mon Nov 3 19:45:04 2014 +0100

    Further changes saga_cmd manfile
---
 debian/rules        |  6 +++--
 debian/saga_cmd.pod | 66 ++++++++++++++++++++++++++++++++++++++++++++++-------
 2 files changed, 62 insertions(+), 10 deletions(-)

diff --git a/debian/rules b/debian/rules
index e21db40..efc24d1 100755
--- a/debian/rules
+++ b/debian/rules
@@ -16,10 +16,12 @@ UPSTREAM_VERSION ?=$(shell uscan --dehs | sed -n 's/.*<upstream-version>\(.*\)<\
 debian/% :: debian/%.in
 	sed -e 's/@VERSION@/$(VERSION)/' $< >$@
 
-override_dh_auto_build:
+override_dh_auto_build: man
+	dh_auto_build
+
+man:
 	pod2man --section=1 --release=$(VERSION) --center " " debian/saga_cmd.pod >saga_cmd.1
 	pod2man --section=1 --release=$(VERSION) --center " " debian/saga_gui.pod >saga_gui.1
-	dh_auto_build
 
 override_dh_python2:
 	dh_python2 --no-guessing-versions
diff --git a/debian/saga_cmd.pod b/debian/saga_cmd.pod
index 80768d3..92e365b 100644
--- a/debian/saga_cmd.pod
+++ b/debian/saga_cmd.pod
@@ -4,28 +4,37 @@ B<saga_cmd> - command-line interface to the System for Automated Geoscientific A
  
 =head1 SYNOPSIS
 
-B<saga_cmd> [-d, --docs]
-[B<SAGA_MLB>=I<dirname>] B<saga_cmd> I<LIBRARY> [I<MODULE>] [B<-silent>] <module specific options...>
+B<saga_cmd> [B<-d, --docs>]
+
+B<saga_cmd> [B<-b, --batch>]
 
 B<saga_cmd> [B<-h, --help>]
 
-=head1 DESCRIPTION
+B<saga_cmd> [B<-f, --flags>][=qrsilpxo][-s, --story][=#][-c, --cores][=#] I<LIBRARY> [I<MODULE>] <module specific options...>
 
-Command line interface to the System for Automated Geoscientific Analyses (SAGA). When run without arguments, the module libraries in the current module library are listed. This can be specified by setting the environment variable I<SAGA_MLB>. If this is not specified, the current working directory is used.
+B<saga_cmd> [B<-f, --flags>][=qrsilpxo][-s, --story][=#][-c, --cores][=#] I<SCRIPT>
+
+=head1 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.
 
+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 'B<-b>' or 'B<--batch>' 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.
+
+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 I<SAGA_MLB>. 
+
 =head1 OPTIONS
 
 =over 8
 
 =item [I<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 current working directory will be searched for instead.
-
-To use the default modules, the environment variable can be set to I</usr/lib/saga>
+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.
 
-=item I<LIBRARY> [I<MODULE>] 
+=item I<LIBRARY> [I<MODULE>] [I<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.
 
@@ -37,6 +46,47 @@ Display help and exit
 
 Create tool documentation in the current working directory
 
+=item B<-b, --batch>
+
+Create batch file examples in the current working directory
+
+=item B<-c, --cores>
+
+Number of physical processors to use for computation
+
+
+=item B<-f, --flags>
+
+Various flags for general usage [qrsilpxo]
+
+=over 9
+
+=item B<q>
+No progress report
+
+=item B<r>
+No messages report
+
+=item B<s>
+Silent mode (no progress and no messages report)
+
+=item B<i>
+Allow user interaction
+
+=item B<l>
+Load translation dictionary
+
+=item B<p>
+Load projections dictionary
+
+=item B<x>
+Use XML markups for synopses and messages
+
+=item B<o>
+Load old style naming
+
+=back
+
 =back
 
 =head1 EXAMPLE

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-grass/saga.git



More information about the Pkg-grass-devel mailing list