print Module

Andrei Pelinescu-Onciul

   FhG FOKUS

Edited by

Andrei Pelinescu-Onciul

   Copyright © 2003 FhG FOKUS
     _________________________________________________________

   Table of Contents
   1. User's Guide

        1.1. Overview
        1.2. Dependencies

              1.2.1. SER Modules
              1.2.2. External Libraries or Applications

        1.3. Exported Parameters

              1.3.1. str_param (string)
              1.3.2. int_param (integer)

        1.4. Exported Functions

              1.4.1. print(txt)

        1.5. Installation & Running

   2. Developer's Guide
   3. Frequently Asked Questions

   List of Examples
   1-1. Set str_param parameter
   1-2. Set int_param parameter
   1-3. print usage
     _________________________________________________________

Chapter 1. User's Guide

1.1. Overview

   Module description

   This is an example module. It implements only one function
   that prints its string parameter to stdout (it won't work if
   ser is started in dameon mode). It also shows how module
   parameters can be declared.
     _________________________________________________________

1.2. Dependencies

1.2.1. SER Modules

   The following modules must be loaded before this module:

     * No dependencies on other SER modules.
     _________________________________________________________

1.2.2. External Libraries or Applications

   The following libraries or applications must be installed
   before running SER with this module loaded:

     * None.
     _________________________________________________________

1.3. Exported Parameters

1.3.1. str_param (string)

   Not used, just an example

   Default value is NULL. 

   Example 1-1. Set str_param parameter
...
modparam("print", "str_param", "foobar")
...
     _________________________________________________________

1.3.2. int_param (integer)

   Not used, just an example.

   Default value is 0. 

   Example 1-2. Set int_param parameter
...
modparam("print", "int_param", 42)
...
     _________________________________________________________

1.4. Exported Functions

1.4.1. print(txt)

   Prints string to stdout.

   Meaning of the parameters is as follows:

     * txt - string to be printed.

   Example 1-3. print usage
...
print("The answer is 42\n");
...
     _________________________________________________________

1.5. Installation & Running

   Notes about installation and running.
     _________________________________________________________

Chapter 2. Developer's Guide

   The module does not provide any sort of API to use in other
   SER modules.
     _________________________________________________________

Chapter 3. Frequently Asked Questions

   3.1. Where can I find more about SER?
   3.2. Where can I post a question about this module?
   3.3. How can I report a bug?

   3.1. Where can I find more about SER?

   Take a look at http://iptel.org/ser.

   3.2. Where can I post a question about this module?

   First at all check if your question was already answered on
   one of our mailing lists:

     * http://mail.iptel.org/mailman/listinfo/serusers
     * http://mail.iptel.org/mailman/listinfo/serdev

   E-mails regarding any stable version should be sent to
   <serusers@iptel.org> and e-mail regarding development versions
   or CVS snapshots should be send to <serdev@iptel.org>.

   If you want to keep the mail private, send it to
   <serhelp@iptel.org>.

   3.3. How can I report a bug?

   Please follow the guidelines provided at:
   http://iptel.org/ser/bugs