SafeFire PPP

v.0.9 beta

Readme

Contents

  1. Installation
  2. Scripts and escape sequences
  3. Configuration file placement
  4. Command line parameters
  5. Configuration file format

Installation

Installation steps:

  1. Create a directory for SafeFire PPP (for ex. c:\tcpip\sfppp)
  2. Unpack SafeFire PPP archive file into that directory
  3. Select needed configuration file and alter it to set up your settings (see "Up and running" book).
  4. You can run SafeFire PPP using the next command: "sfppp -Cconfig_file_name"

NOTE:

While documentation for SafeFire PPP is not complete, in some cases you may refer to samples/descript.txt. Some useful information can be obtained from description of the configuration options provided in that file.

NOTE:

SafeFire PPP uses SYSLOG facility to produce log files. Installation and configuration of this utility is described in TCP/IP Command Reference.

Another way to produce log file useable for troubleshooting:

sfppp -Cconfig_file_name 2>&1 | copyf.cmd log_file_name

copyf.cmd can be found in the BIN subdirectory of the SafeFire PPP package.

Return to Contents

Scripts and special characters

Scripts

There is an internal dialer in SafeFire PPP. It has 3 work modes

Working mode can be set using port.script.mode configuration variables that has three possible values:

Escape sequences

Each send command is send as CR-terminated line. It may contain sequences of characters which has special meaning. This sequences will be replaced with something other, depending from the sequence. These sequences are called escape sequences. Full list of escape sequences follows:

NOTE 1: No special characters will be replaced in the receive command. NOTE 2: Escape sequences are interpreted in port.modem.init as well. For example if modem init string contains \T sequence it should be replaced with \\T to avoid expanding it into phone number.

Return to Contents

Configuration file placement

If you do not specify configuration file in command line, SafeFire PPP uses "sfppp.cfg" as default configuration file name. This file will be searched in the next folders (in the order specified below):

  1. Current directory
  2. Directory specified by ETC environment variable
  3. Directory specified by HOME environment variable
  4. Directory specified by LGSDIR environment variable

Return to Contents

Command line parameters

SafeFire PPP accepts the next command line parameters:
-Cfilename use filename configuration file
-Rsection use starting loading section section.
Note: Sections are loaded recursively starting from specified section using binding information.
-Dvariable_definition

This command is used to define (or alter) variable definitions from configuration file.

Definition has the following format:

section#variable=value
For example: -Dppp#port.name=com2

Note 1: Command-line parameters names(-C, -R, -D) are case sensitive.
Note 2: There are no spaces between parameter name and value.

Return to Contents

Configuration file format

Configuration file consists of sections. Each section define variables. Each section has it's name. Variables that has the same name in sections with different names are different variables.

Variable definition has the next format: "name delimiter value"

For string variables the value is the whole configuration line starting from the first non-space symbol after the delimiter.

Some sections has special names:

  1. general

    All variables from this section will be included into all other sections

  2. ppp

    This is default starting section

Each section can include unlimited number of files and other sections. You can use next commands:

!include "filename"
@include "section"

Note: If "filename" has section definitions, the active session after processing include file will be the last session defined in the include file.

Note 1: Multiple sections with the same name make up one logical section.
Note 2: If one regular variable defined multiple times the last specified value is used. (Non-regular variables examples are bindings and firewall rule definitions)

Return to Contents
Return to documentation index SafeFire PPP (C) Link Guard Solutions 1999