Man Page Template

Use this page to template a man page you have been asked to write in trac.

LAST UPDATED ON

date of the last update made on this page

NAME

provide name of the software here

STATUS

You can set status to any of the following:

ACTIVE,DEPRECATED,UNDER DEVELOPMENT,UNKNOWN

PURPOSE

provide information on why it exists and what does it do.

HOW TO RUN

provide information on how to run this software and about all command-line options and execution modes.

CONFIGURATION FILE

provide complete information about configuration file format and parameters in following format.

<parameter name> <data type> <default value>

<description>

<parameter name> <data type> <default value>

<description>

DEPENDENCIES

List SCSN softwares, third party softwares and others resources (e.g database tables, files) it depends on to work properly.

MAINTENANCE

give information on how to maintain its execution/operations under production environment.

AUTHORS

Provide list of contributors in following format <Name of the contributor> <Name of the organization/company> <E-mail address> <active|inactive>

BUG REPORTING

Provide primary contact who can fix the bugs.

MORE INFORMATION

Provide links to other documentation related to the software.

= Man Page  Template =

Use this page to template a man page you have been asked to write in trac.

== LAST UPDATED ON ==

     date of the last update made on this page

== NAME ==

     provide name of the software here

== STATUS ==

     You can set status to any of the following:
      ACTIVE,DEPRECATED,UNDER DEVELOPMENT,UNKNOWN

== PURPOSE ==

     provide information on why it exists and what does it do.

== HOW TO RUN ==

     provide information on how to run this software
     and about all command-line options and execution modes.

== CONFIGURATION FILE ==

     provide complete information about configuration file format and parameters in following format.

     <parameter name> <data type> <default value>
               <description>

     <parameter name> <data type> <default value>
               <description>

== DEPENDENCIES ==

     List SCSN softwares, third party softwares and others resources (e.g database tables, files) it depends on to work properly.

== MAINTENANCE ==

     give information on how to maintain its execution/operations under production environment.        

== AUTHORS ==

     Provide list of contributors in following format
     <Name of the contributor> <Name of the organization/company> <E-mail address> <active|inactive>

== BUG REPORTING ==

    Provide primary contact who can fix the bugs.

== MORE INFORMATION ==

    Provide links to other documentation related to the software.