diff options
| author | panne <unknown> | 2003-08-27 08:53:17 +0000 |
|---|---|---|
| committer | panne <unknown> | 2003-08-27 08:53:17 +0000 |
| commit | aa399f6e3a97392b9adebccac9abee2672f79dd5 (patch) | |
| tree | 9a7c4530968ccff9e2b7b2b898f344e281912cc7 /docs/coding-style.html | |
| parent | 31faec30a23fec5cf48d5aa1c08d46c84b55f220 (diff) | |
| download | haskell-aa399f6e3a97392b9adebccac9abee2672f79dd5.tar.gz | |
[project @ 2003-08-27 08:53:17 by panne]
Added a section about commandline arguments
Diffstat (limited to 'docs/coding-style.html')
| -rw-r--r-- | docs/coding-style.html | 30 |
1 files changed, 28 insertions, 2 deletions
diff --git a/docs/coding-style.html b/docs/coding-style.html index 0ce4a3d6be..8fbb27688c 100644 --- a/docs/coding-style.html +++ b/docs/coding-style.html @@ -2,11 +2,11 @@ <HTML> <HEAD> <meta http-equiv="content-type" content="text/html;charset=iso-8859-1"> - <TITLE>GHC Style Guidelines for C code</TITLE> + <TITLE>Style Guidelines for fptools</TITLE> </HEAD> <BODY> -<H1>GHC Style guidelines for C code</h1> +<H1>Style Guidelines for fptools</h1> <h2>Comments</h2> @@ -512,5 +512,31 @@ it in case anyone else is changing that file. </ul> +<h2>Commandline arguments</h2> + +A program in fptools should try follow the following rules for +commandline arguments: + +<ul> +<li> The <code>-v</code> and <code>--verbose</code> options should be +used to generate verbose output (intended for the user). + +<li> The <code>-d</code> and <code>--debug</code> options should be +used to generate debugging output (intended for the developer). + +<li> The <code>-?</code> and <code>--help</code> options should be used +to display usage information on stdout. The program should exit +successfully afterwards. + +<li> The <code>-V</code> and <code>--version</code> options should be +used to output version information on stdout, which includes one line +of the form '<code><em>Program</em> version +<em>Major.Minor[.Patchlevel]</em> ... </code>'. The program +should exit successfully afterwards. +</ul> + +When an unknown commandline argument is encountered, the program +should display usage information on stderr and exit unsuccessfully. + </body> </html> |