next up previous [pdf]

Next: Piping Up: Command line interface Previous: Using programs

Self-documentation

Of course, we can specify as many parameters as we'd like on the command line. To figure out which parameters are needed for a specific program, just type the name of the program with no input files our output files on the command line to bring up a program's self-documentation. For example, sfwindow's self documentation is:
\begin{verbatimtab}[4]
NAME
sfwindow
DESCRIPTION
Window a portion of a dataset...
...rg/wiki/Guide_to_madagascar_programs ...

The self-documentation tells us the function of the program, as well as the parameters that are available to be specified. The parameter format is type - name=default value [options] and then a short description of the parameter. File parameters request a name of a file. For example:

 
file=file.rsf

Note: strings with spaces must be enclosed in quotation marks (e.g. 'my value') so that the Unix shell could interpret them correctly.




2011-11-03