Category:Command-line arguments

From ArachneWiki

(Difference between revisions)
Jump to: navigation, search
(New page: Arachne's executable modules accept '''command-line arguments''', in much the same style as Unix shells. Command-line arguments specify important details about a module's executio...)
Current revision (21:44, 3 May 2008) (edit) (undo)
 
Line 1: Line 1:
-
[[Arachne]]'s [[executable module]]s accept '''command-line arguments''', in much the same style as Unix shells. Command-line arguments specify important details about a module's execution, such as the [[directories]] in which it finds [[input]] and [[output]] files, flags for what [[algorithms]] to run, and numeric parameters for its algorithms.
+
[[Arachne]]'s [[executable module]]s accept '''command-line arguments''', in much the same style as Unix shell commands. Command-line arguments specify important details about a module's execution, such as the [[directories]] in which it finds [[input]] and [[output]] files, flags for what [[algorithms]] to run, and numeric parameters for its algorithms.
The general syntax for any executable module is
The general syntax for any executable module is
<module location and name> ARG1=val1 ARG2=val2 ...
<module location and name> ARG1=val1 ARG2=val2 ...
where the <tt>ARG</tt>s and <tt>val</tt>s are command-line arguments and their values. Note that there can be no spaces before or after the equals signs, unless you are specifying a null value (which is legitimate.)
where the <tt>ARG</tt>s and <tt>val</tt>s are command-line arguments and their values. Note that there can be no spaces before or after the equals signs, unless you are specifying a null value (which is legitimate.)
- 
-
Each module has a set of command-line arguments that it handles. Some arguments must be specified, or the module will not run; other arguments are optional, and if you do not specify them, they will take on default values. In certain cases (such as [[ARACHNE_PRE]]) you can specify a default value for a command-line argument as an [[environment variable]]. To get a complete list of a module's arguments and their default values, run the module with no arguments.
 
Command-line arguments may be any of the following types:
Command-line arguments may be any of the following types:
-
* Integer or floating-point number
+
* Integer
 +
* Floating-point number (float or double)
* [[Index list]]
* [[Index list]]
* [[Boolean]] (flag)
* [[Boolean]] (flag)
Line 15: Line 14:
By convention, directory names and other module-invariant argument names are in ALL CAPS. Other arguments may be in ALL CAPS or lowercase; there is little consistency.
By convention, directory names and other module-invariant argument names are in ALL CAPS. Other arguments may be in ALL CAPS or lowercase; there is little consistency.
 +
 +
=== Specifying command-line arguments ===
 +
 +
Each module has a set of command-line arguments that it handles. Some arguments must be specified; other arguments are optional, and if you do not specify them, they will take on default values. The default values are usually perfectly acceptable to use, and thus you do not need to go to the trouble of learning the meaning of every single command-line argument, unless you want to run a module exactly to your liking. To get a complete list of a module's arguments and their default values, run the module with no arguments.
 +
 +
Some command line arguments (e.g., [[PRE]]) can be specified implicitly by means of an [[environment variable]].

Current revision

Arachne's executable modules accept command-line arguments, in much the same style as Unix shell commands. Command-line arguments specify important details about a module's execution, such as the directories in which it finds input and output files, flags for what algorithms to run, and numeric parameters for its algorithms.

The general syntax for any executable module is

<module location and name> ARG1=val1 ARG2=val2 ...

where the ARGs and vals are command-line arguments and their values. Note that there can be no spaces before or after the equals signs, unless you are specifying a null value (which is legitimate.)

Command-line arguments may be any of the following types:

  • Integer
  • Floating-point number (float or double)
  • Index list
  • Boolean (flag)
  • Filename
  • Directory name

By convention, directory names and other module-invariant argument names are in ALL CAPS. Other arguments may be in ALL CAPS or lowercase; there is little consistency.

Specifying command-line arguments

Each module has a set of command-line arguments that it handles. Some arguments must be specified; other arguments are optional, and if you do not specify them, they will take on default values. The default values are usually perfectly acceptable to use, and thus you do not need to go to the trouble of learning the meaning of every single command-line argument, unless you want to run a module exactly to your liking. To get a complete list of a module's arguments and their default values, run the module with no arguments.

Some command line arguments (e.g., PRE) can be specified implicitly by means of an environment variable.

Articles in category "Command-line arguments"

There are 8 articles in this category.

D

G

K

N

O

P

R

S

Personal tools