]> &title; @DATE@ &package; &firstname; &surname; Code and documentation.
&email;
2012 2013 2014 2015 2016 &firstname; &surname; <&email;> This manual page was written for the DeforaOS project (and may be used by others). Permission is granted to copy, distribute and/or modify this document under the terms of the GNU General Public License, Version 3 as published by the Free Software Foundation.
&name; 1 &name; &purpose; &name; MIME type module action ID title variable=value Description The &name; command line utility can locate a local installation of the &package; Content Management System, and issue requests directly. A single request can be issued per invocation of the &name; 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: Enables debugging mode. Sets a MIME type for the output format (default: text/plain). Allows requests to not be idempotent. Sets the module to be invoked. Sets the action to be called. Sets the request's ID. Sets the request's title. Sets additional parameter values. Requests &package; 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 &package;; they are however denied from external tools like &name;. Files @PREFIX@/etc/daportal.conf Configuration file for the &name; script. Environment The following environment variables affect the execution of &name;: 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 . Importantly, the &name; command (and therefore, this manual page) assumes the engine configured or selected by &package; to be CliEngine, or inheriting from CliEngine. &package; 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. See also daportal.conf 5