A complete module example.

A complete module example.

A short description.

File: full_module.sh

The long description of this module. On multiple lines.

Another paragraph.

Available Functions
a_fct The short description of the function on two lines.
old_foo A deprecated function.

a_fct()

The short description of the function on two lines.

Usage

        a_fct value [element ...]
    

Description

The long description of the function.

Positional arguments

Argument Type Index(es) Description
value str 1 A first value.
element str 2* A list of values.

Outputs

Stream/Status Type Description
status int Returns 0.
stdout int A positive number, otherwise -1.

old_foo()

DEPRECATED

A deprecated function.

Usage

        old_foo
    

Description

This old function was doing something nice.

Positional arguments

Argument Type Index(es) Description

Outputs

Stream/Status Type Description