Manual browser: daportal(1)

Name

daportal — Invoke DaPortal requests from the command line

Synopsis

daportal [-D] [-M MIME type] [-f] [-m module] [-a action] [-i ID] [-q] [-t title] [-v] [-o variable=value...]

Description

The daportal command line utility can locate a local installation of the DaPortal Content Management System, and issue requests directly. A single request can be issued per invocation of the daportal command.

By default, it ensures that requests do not affect the state of the local installation (idempotence). Updates can however be allowed with a special argument.

Options

The following options are available:

-D: Enables debugging mode.
-M: Sets a MIME type for the output format (default: “text/plain”).
-f: Allows requests to not be idempotent.
-m: Sets the module to be invoked.
-a: Sets the action to be called.
-i: Sets the request's ID.
-t: Sets the request's title.
-o: Sets additional parameter values.

Requests

DaPortal requests are messages sent to the processing engine selected, which in turn dispatches them to the right module. Requests are composed of:

a module name
an action (optional)
an ID (optional)
a title (optional), which should usually match the ID's title in database
an additional list of parameters (optional)

Unspecified parameters may be set automatically, depending on the engine running and the configuration.

By default, requests are considered idempotent: the state of the database remains the same before and after the request, triggering equivalent results when the request is repeated. Other operations are considered privileged, and require a special flag to work.

Requests are also sent and received internally by DaPortal; they are however denied from external tools like daportal.

Files

/usr/local/etc/daportal.conf: Configuration file for the daportal script.

Environment

The following environment variables affect the execution of daportal:

DAPORTALCONF: Path to an alternative configuration file.
DAPORTAL_USERNAME: Username to login against (requires environment-based authentication, like provided by the EnvAuth authentication backend)

Bugs

Issues can be listed and reported at http://www.defora.org/os/project/bug_list/12/DaPortal.

Importantly, the daportal command (and therefore, this manual page) assumes the engine configured or selected by DaPortal to be CliEngine, or inheriting from CliEngine. DaPortal may however be configured or extended with additional engines, which may expect different arguments, function differently, have differing output (such as GtkEngine) or may not even work at all from the command line interface.