A complete module example.

File: full_module.sh

A short description.

Description

The long description of this module. On multiple lines.

source "full_module.sh"

declare s=John

echo "Hello $s!"
Hello John!
source "full_module.sh"

echo "Example: my-script [first_value] <second_value>"
Example: my-script [first_value] <second_value>

Another paragraph.

Functions

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

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.

Streams

Stream Type Description
stdout int A positive number, otherwise -1.

Status

Value Description
1 When a wrong value is submitted.

Exit cases & values

Value Description
1 Exits with error code on various error cases.

old_foo()

A deprecated function.

Usage

  old_foo

Deprecated

This function is deprecated.

Description

This old function was doing something nice.