mirror of
https://github.com/worldforge/cyphesis
synced 2026-08-13 12:26:04 -04:00
219 lines
8.3 KiB
Text
219 lines
8.3 KiB
Text
<refentry id="cyphesis-tools">
|
|
|
|
<refmeta>
|
|
<refentrytitle>cyphesis-tools</refentrytitle>
|
|
<manvolnum>1</manvolnum>
|
|
</refmeta>
|
|
|
|
<refnamediv>
|
|
<refname>cyconfig, cyconvertrules, cydumprules, cyloadrules, cypasswd, cypython, cydb</refname>
|
|
<refpurpose>cyphesis tools</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsynopsisdiv>
|
|
<cmdsynopsis>
|
|
<command>/usr/bin/cyaddrules</command>
|
|
<arg choice="opt" rep="repeat">--section:option=value</arg>
|
|
<arg choice="opt">rulesetname atlas-xml-file</arg>
|
|
</cmdsynopsis>
|
|
<cmdsynopsis>
|
|
<command>/usr/bin/cyconfig</command>
|
|
<arg choice="opt" rep="repeat">--section:option=value</arg>
|
|
</cmdsynopsis>
|
|
<cmdsynopsis>
|
|
<command>/usr/bin/cyconvertrules</command>
|
|
<arg choice="req">rule_file</arg>
|
|
</cmdsynopsis>
|
|
<cmdsynopsis>
|
|
<command>/usr/bin/cydumprules</command>
|
|
</cmdsynopsis>
|
|
<cmdsynopsis>
|
|
<command>/usr/bin/cyloadrules</command>
|
|
<arg choice="opt" rep="repeat">--section:option=value</arg>
|
|
<arg choice="opt">rulesetname atlas-xml-file</arg>
|
|
</cmdsynopsis>
|
|
<cmdsynopsis>
|
|
<command>/usr/bin/cypasswd</command>
|
|
<group choice="opt">
|
|
<group choice="req">
|
|
<arg choice="req">-a</arg>
|
|
<arg choice="req">-s</arg>
|
|
<arg choice="req">-d</arg>
|
|
</group>
|
|
<arg choice="req">account</arg>
|
|
</group>
|
|
</cmdsynopsis>
|
|
<cmdsynopsis>
|
|
<command>/usr/bin/cyexport</command>
|
|
<arg choice="req">filepath</arg>
|
|
</cmdsynopsis>
|
|
<cmdsynopsis>
|
|
<command>/usr/bin/cyimport</command>
|
|
<arg choice="req">filepath</arg>
|
|
</cmdsynopsis>
|
|
<cmdsynopsis>
|
|
<command>/usr/bin/cypython</command>
|
|
<arg choice="opt" rep="repeat">--section:option=value</arg>
|
|
</cmdsynopsis>
|
|
<cmdsynopsis>
|
|
<command>/usr/bin/cydb</command>
|
|
<arg choice="opt" rep="repeat">--section:option=value</arg>
|
|
<arg choice="req">dataset</arg>
|
|
<arg choice="req">action</arg>
|
|
</cmdsynopsis>
|
|
</refsynopsisdiv>
|
|
|
|
<refsect1><title>Description</title>
|
|
<para>
|
|
The cyphesis tools manage the data and configuration files used by cyphesis.
|
|
</para>
|
|
<para>
|
|
The <command>cyaddrules</command> tool uploads Atlas XML rules files into the
|
|
a running server. If rules already exist in the server, then the default
|
|
attributes are updated, and if the rule has a script associated with it,
|
|
then the script is reloaded from file. <command>cyaddrules</command> can
|
|
either upload the file given on the command line, or if none is specified it
|
|
will upload the rule file for the ruleset specified in the server config,
|
|
and any rule files it depends on. <command>cyaddrules</command> is typically
|
|
used to add additional rules during rule development without having to
|
|
restart the server. Rules can be loaded directly into a running server
|
|
using <command>cyaddrules</command>.
|
|
</para>
|
|
<para>
|
|
The <command>cyconfig</command> program provides an easy scriptable way to
|
|
make permanent changes to the server config from the command line.
|
|
It works by writing new config options to <filename>.cyphesis.vconf</filename>
|
|
in the users home directory, which is read by the server at startup,
|
|
and overrides the contents of the main config file. For a description of
|
|
the various options that the server takes, please see
|
|
<citerefentry><refentrytitle>cyphesis</refentrytitle><manvolnum>1</manvolnum>
|
|
</citerefentry>.
|
|
</para>
|
|
<para>
|
|
The <command>cyconvertrules</command> program converts Atlas XML rules files
|
|
from an older historic format into the format used by cyphesis since
|
|
version 0.3.1.
|
|
</para>
|
|
<para>
|
|
The <command>cydumprules</command> program dumps rules from the database table
|
|
used by the server into a set of Atlas XML rules files. Note that this does
|
|
not produce a set of files containing the same rules as those that were loaded
|
|
in using <command>cyloadrules</command> because some of the rules in the
|
|
rulesets that were not top level may have been overloaded, and do not exist
|
|
in the database table. Typically this command will be used to get an updated
|
|
copy of the top level ruleset from the server database, and the rest of the
|
|
files will be ignored.
|
|
</para>
|
|
<para>
|
|
The <command>cyloadrules</command> tool loads Atlas XML rules files into the
|
|
database table used by the server. The rules table is read by the
|
|
server at startup, so a server restart is typically required after loading
|
|
rules. <command>cyloadrules</command> can either load the file given on
|
|
the command line, or if none is specified it will load the rule file for
|
|
the ruleset specified in the server config, and any rule files it depends on.
|
|
Rules can be loaded directly into a running server using
|
|
<command>cyaddrules</command>.
|
|
</para>
|
|
<para>
|
|
The <command>cypasswd</command> tool is used to administrate the accounts table
|
|
in the server database.
|
|
</para>
|
|
<para>
|
|
The <command>cyexport</command> tool exports entities (and optionally rules) from
|
|
a running server into a file. The file generated can be imported into a server
|
|
through the tool <command>cyimport</command>.
|
|
</para>
|
|
<para>
|
|
The <command>cyimport</command> tool imports entities and rules from a file,
|
|
previously exported through the <command>cyexport</command> tool, into a
|
|
running server.
|
|
</para>
|
|
<para>
|
|
The <command>cypython</command> tool allows you to execute Python code in a
|
|
running server. This command must be run on the same machine as the server
|
|
(it uses domain sockets for communication with the server). When run the user
|
|
is presented with an interactive console into which Python code can be entered.
|
|
Commands are sent to the server by pressing enter.
|
|
</para>
|
|
<para>
|
|
The <command>cydb</command> tool is used to perform maintanence on the server
|
|
database. Use only when the server is offline.
|
|
The first argument specified which dataset to work with, and the second argument
|
|
specifies the action for that data set.
|
|
The following datasets are supported:
|
|
</para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term>rules</term>
|
|
<listitem>
|
|
<para>Purge and list rules.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>user</term>
|
|
<listitem>
|
|
<para>Purge, list, delete or modify user entries.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term>user</term>
|
|
<listitem>
|
|
<para>Purge the world of all entities.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</refsect1>
|
|
|
|
<refsect1><title>Options</title>
|
|
<para>
|
|
The <command>cypasswd</command> can either add a new account, set the password
|
|
of an existing account, or remove an account from the database. When no
|
|
arguments are given, it prompts for a new admin password for cyphesis.
|
|
When run with the <option>-a</option> option, the command prompts for a
|
|
password to be entered and an account with the username given by <option>account</option>,
|
|
and with the password supplied at the prompt is created. When run with the
|
|
<option>-s</option> option, the command prompts for a password, and the
|
|
existing account with username given by <option>account</option> has its password changed to
|
|
the new one entered. When run with the <option>-d</option> option, the
|
|
account with username given by <option>account</option> is removed from the database.
|
|
</para>
|
|
<para>
|
|
Whenever the <command>cypasswd</command> prompts for a password, a second
|
|
prompt is displayed asking for confirmation of the password. If the two
|
|
password entered do not match, the operation is aborted, and no changes are
|
|
made to the database.
|
|
</para>
|
|
<para>
|
|
The <command>cyexport</command> by default only exports entities, but can also
|
|
export rules through the option <option>--export:rules=1</option>.
|
|
By default no transient entities are exported. This can be changed by the
|
|
option <option>--export:transients=1</option>
|
|
</para>
|
|
</refsect1>
|
|
<refsect1><title>Author</title>
|
|
<para>
|
|
Written by Alistair Riddoch and Erik Ogenvik.
|
|
</para>
|
|
</refsect1>
|
|
<refsect1><title>Reporting bugs</title>
|
|
<para>
|
|
Report bugs to <email>general@worldforge.org</email>.
|
|
</para>
|
|
</refsect1>
|
|
<refsect1><title>Copyright</title>
|
|
<para>
|
|
Copyright 2004 Alistair Riddoch.
|
|
Copyright 2013 Erik Ogenvik.
|
|
</para>
|
|
</refsect1>
|
|
<refsect1><title>See Also</title>
|
|
<para>
|
|
<citerefentry><refentrytitle>cyphesis</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
|
|
<citerefentry><refentrytitle>cyclient</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
|
|
<citerefentry><refentrytitle>cycmd</refentrytitle><manvolnum>1</manvolnum></citerefentry>
|
|
</para>
|
|
</refsect1>
|
|
</refentry>
|