<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Program arguments — C-Munipack 2.0.8 documentation</title>
<link rel="stylesheet" href="_static/default.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '',
VERSION: '2.0.8',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<link rel="top" title="C-Munipack 2.0.8 documentation" href="index.html" />
<link rel="up" title="Command line tools" href="command_line_tools.html" />
<link rel="next" title="Using configuration files" href="using_configuration_files.html" />
<link rel="prev" title="Using command-line tools" href="using_command_line_tools.html" />
</head>
<body>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="using_configuration_files.html" title="Using configuration files"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="using_command_line_tools.html" title="Using command-line tools"
accesskey="P">previous</a> |</li>
<li><a href="index.html">C-Munipack 2.0.8 documentation</a> »</li>
<li><a href="command_line_tools.html" accesskey="U">Command line tools</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<span class="target" id="index-0"></span><div class="section" id="program-arguments">
<h1>Program arguments<a class="headerlink" href="#program-arguments" title="Permalink to this headline">ΒΆ</a></h1>
<p>The user command accept a list of command-line arguments, that provides requisite
information for its execution. They are used to specify names of input files, values of
configuration parameters etc. Some arguments are obligatory, others are optional only.</p>
<p>The syntax of command-line arguments follows in general the GNU/POSIX conventions.
The arguments are separated by a single space character, in case an argument itself contain
a space, it must be enclosed in double-quotes. Refer to the documentation of your shell for
more details.</p>
<p>There are two types of command-line arguments - options and positional parameters.
Options are optional, while positional parameters are always obligatory.</p>
<p>The options are used to provide extra information to customize the execution
of a command. Each option has a full form starting with two dashes and an optional short
form starting with one dash only. Options are case-sensitive. It is allowed to
merge two or more successive short options together. Some options require a value;
in this case a value is taken from a subsequent argument. When a full form is
used, an option and its value can also be separated by an equal sign. When a
short form is used, its value can immediately follow the option. Whenever there is a
conflict between a configuration file parameter and an option of the same meaning,
the option always take precedence.</p>
<p>All arguments that are not options nor option values are regarded as positional
parameters. First such argument specify value of the first positional parameter and so on.
Some parameters take variable number of arguments, usually list of input files. This case
is indicated in the synopsis by an ellipsis (...) following the parameter name. It means
that it takes all following positional parameters.</p>
<p>All following user commands are equivalent:</p>
<div class="highlight-python"><pre>prog --option-a --option-b xyz --option-c=123 file1 file2
prog -a -b xyz -c123 file1 file2
prog -abxyz -c123 file1 file2</pre>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h4>Previous topic</h4>
<p class="topless"><a href="using_command_line_tools.html"
title="previous chapter">Using command-line tools</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="using_configuration_files.html"
title="next chapter">Using configuration files</a></p>
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="using_configuration_files.html" title="Using configuration files"
>next</a> |</li>
<li class="right" >
<a href="using_command_line_tools.html" title="Using command-line tools"
>previous</a> |</li>
<li><a href="index.html">C-Munipack 2.0.8 documentation</a> »</li>
<li><a href="command_line_tools.html" >Command line tools</a> »</li>
</ul>
</div>
<div class="footer">
© Copyright 2012, David Motl.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3.
</div>
</body>
</html>
