From aa399f6e3a97392b9adebccac9abee2672f79dd5 Mon Sep 17 00:00:00 2001 From: panne Date: Wed, 27 Aug 2003 08:53:17 +0000 Subject: [PATCH] [project @ 2003-08-27 08:53:17 by panne] Added a section about commandline arguments --- docs/coding-style.html | 30 ++++++++++++++++++++++++++++-- 1 file changed, 28 insertions(+), 2 deletions(-) diff --git a/docs/coding-style.html b/docs/coding-style.html index 0ce4a3d..8fbb276 100644 --- a/docs/coding-style.html +++ b/docs/coding-style.html @@ -2,11 +2,11 @@ - GHC Style Guidelines for C code + Style Guidelines for fptools -

GHC Style guidelines for C code

Style Guidelines for fptools

Comments

@@ -512,5 +512,31 @@ it in case anyone else is changing that file. +

Commandline arguments

+ +A program in fptools should try follow the following rules for +commandline arguments: + +

The -v and --verbose options should be +used to generate verbose output (intended for the user). + +
The -d and --debug options should be +used to generate debugging output (intended for the developer). + +
The -? and --help options should be used +to display usage information on stdout. The program should exit +successfully afterwards. + +
The -V and --version options should be +used to output version information on stdout, which includes one line +of the form 'Program version +Major.Minor[.Patchlevel] ...'. The program +should exit successfully afterwards. +

+ +When an unknown commandline argument is encountered, the program +should display usage information on stderr and exit unsuccessfully. + -- 1.7.10.4