Documentation

From FITSH
(Difference between revisions)
Jump to: navigation, search
m
m
 
Line 1: Line 1:
 
Currently, documentation about this program/project is available in the following forms:
 
Currently, documentation about this program/project is available in the following forms:
* All of the programs/tasks are capable to provide a shorter and a longer list of command line help options and description that are available via the <code>--help</code> and <code>--long-help</code> options, respectively. The <code>--help</code> option simply lists the available options and switches with a minimalistic references of the actual syntax while <code>--long-help</code> gives a detailed description.
+
* All of the programs/tasks are capable to provide a shorter and a longer list of command line help options and description that are available via the <code>--help</code> and <code>--long-help</code> options, respectively. The <code>--help</code> option simply lists the available options and switches with a minimalist references of the actual syntax while <code>--long-help</code> gives a detailed description.
 
* All of the programs/tasks are capable to provide a Mediawiki-formatted output about the available options by using the <code>--wiki-help</code> command line argument.
 
* All of the programs/tasks are capable to provide a Mediawiki-formatted output about the available options by using the <code>--wiki-help</code> command line argument.
 
* You can find a more detailed summary about the specific programs/tasks [[Tasks|here]].
 
* You can find a more detailed summary about the specific programs/tasks [[Tasks|here]].
* There is an all-in-one document in PDF format describing the above mentioned options and features some examples as well.
 
 
* See also the [[Example:Main_Page|Examples]] section of this web page.
 
* See also the [[Example:Main_Page|Examples]] section of this web page.
   
Please provide feedback if the documentation seems to be incomplete and/or incosistent.
+
Please provide feedback if the documentation seems to be incomplete and/or inconsistent.
   
 
{{Documentation}}
 
{{Documentation}}

Latest revision as of 16:23, 20 October 2016

Currently, documentation about this program/project is available in the following forms:

  • All of the programs/tasks are capable to provide a shorter and a longer list of command line help options and description that are available via the --help and --long-help options, respectively. The --help option simply lists the available options and switches with a minimalist references of the actual syntax while --long-help gives a detailed description.
  • All of the programs/tasks are capable to provide a Mediawiki-formatted output about the available options by using the --wiki-help command line argument.
  • You can find a more detailed summary about the specific programs/tasks here.
  • See also the Examples section of this web page.

Please provide feedback if the documentation seems to be incomplete and/or inconsistent.

Personal tools