OPENSCADA(1)

NAME
openscada_start - Projects oriented OpenSCADA start script

SYNOPSIS
openscada_start [options]

DESCRIPTION
OpenSCADA system is an open implementation of SCADA (Supervisory Control And Data Acquisition) and HMI (Human-Machine Interface) systems. The main properties of the system are: openness(GPL), multiplatform, modularity and scalability.

Heart of the system is the modular kernel. Depending on what modules are connected, the system can carry out both functions of various servers, and functions of clients of client-server architecture. Actually, the architecture of system allows you to realize the distributed client-server systems of any complexity and mixing. For achievement of high speed due to reduction of communications time, the architecture allows to unite functions of the distributed systems into one program.

The script openscada_start is projects oriented wrapper to the main starter program openscada which allows creation new projects and independent start its. Also the script perform tracing, processing and generation crash reports, if allowed gdb.

The project of OpenSCADA is directory named to the project name and placed to the OpenSCADA data directory /usr/share/openscada/, for preinstalled projects, and ~/.openscada/ for user-space projects.

The project name ProjName can be passed into environment "OSCADA_ProjName=ProjName" or by symbol link name "openscada_ProjName" to the script.

Call the script without a project name ProjName set will cause a dialog for select a new project creation or execute preinstalled and user-space projects. Execution a preinstalled project from the user space will cause the project's config file /etc/oscada_ProjName.xml and directory copy to OpenSCADA user-space data directory ~/.openscada/, for the user allow to modify the project.

For selection and new project name dialogs building supported the dialog programs, into the priority checking: dialog (for active terminal present), kdialog, zenity and Xdialog.

For access to a new project (default configurations) use account "root" and password "openscada" or account "user" and password "user".

The script pass all options to openscada but some it uses for the projects enviroment prepare!

OPTIONS

  Generic options:

  -h, --help
Info message about the system OpenSCADA options.

--config=file
    The station configuration file.

--station=id
    The station identifier.

--statName=name
    The station name.

--demon, --daemon
    Start into the daemon mode.

--pidFile=file
    The file for the programm process ID place here.

--coreDumpAllow
    Set limits for a core dump creation allow on the crash.

--modPath=path
    Modules path (/var/os/modules/).

--messLev=level
    Process messages level (0-7).

--log=direct
    Direct messages to, by bitfield:
    0x1 - syslogd;
    0x2 - stdout;
    0x4 - stderr;
    0x8 - the messages archive.

  The module <Archive:FSArch> options:

--noArchLimit
    Disable archives limit to the file number. Use for see archives mode, not work.

  The module <UI:QTStarter> options:

--sync
    Switches to synchronous mode X11 for debugging.

--widgetcount
    Prints debug message at the end about number of widgets left undestroyed and maximum number of widgets existed at the same time.

--qws
    With Qt for Embedded Linux makes this application the server.

--style=nm
    Sets GUI style to nm (windows, platinum, plastique, ...).

--stylesheet=path
    Sets styleSheet by path to file that contains.

--session=nm
    Restores from an earlier session nm.

--reverse
    Sets layout direction to Qt::RightToLeft.

--graphicssystem=nm
    Sets the backend to be used for on-screen widgets and QPixmaps (raster, opengl).

--display=nm
    Sets the X display name (default it is $DISPLAY).

--geometry=geom
    Sets the client geometry of the first window that is shown.

ENVIRONMENT

OSCADA_ProjName
    Set OSCADA_ProjName environment to an executed project's name.

FILES

/etc/oscada.xml
    OpenSCADA default configuration file

/usr/share/openscada/
    Global data files and preinstaled projects directory of OpenSCADA

~/.openscada/
    User-space projects directory of OpenSCADA

/etc/oscada_ProjName.xml
    The preinstalled project ProjName configuration file

ProjName/oscada.xml
    The project ProjName configuration file

ProjName/*.db
    The project ProjName SQLite DB local files

ProjName/*.crash
    The project ProjName crash reports

ProjName/icons/*
    The project ProjName specific media files

ProjName/docs/*
    The project ProjName specific documentation files

SEE ALSO
openscada(1), dialog(1), kdialog(1), zenity(1)

http://oscada.org
    OpenSCADA project's main site

http://wiki.oscada.org
    WIKI -resource with all the documentation source

    Full user documentation is available through the GUI configuration module like QTCfg

AUTHORS
Roman Savochenko <roman@oscada.org>