NAME
cyconfig, cyconvertrules, cydumprules, cyloadrules, cypasswd - cyphesis
tools
SYNOPSIS
/usr/bin/cyaddrules [ --section:option=value ... ] [ rulesetname atlas-
xml-file ]
/usr/bin/cyconfig [ --section:option=value ... ]
/usr/bin/cyconvertrules rule_file
/usr/bin/cydumprules
/usr/bin/cyloadrules [ --section:option=value ... ] [ rulesetname
atlas-xml-file ]
/usr/bin/cypasswd [ { -a | -s | -d } account ]
DESCRIPTION
The cyphesis tools manage the data and configuration files used by
cyphesis.
The cyaddrules 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. cyaddrules 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. cyaddrules 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
cyaddrules.
The cyconfig 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 .cyphesis.vconf 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 cyphesis(1).
The cyconvertrules program converts Atlas XML rules files from an older
historic format into the format used by cyphesis since version 0.3.1.
The cydumprules 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 cyloadrules 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.
The cyloadrules 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.
cyloadrules 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 cyaddrules.
The cypasswd tool is used to administrate the accounts table in the
server database.
OPTIONS
The cypasswd 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 -a option, the command prompts for a password to be
entered and an account with the username given by account, and with the
password supplied at the prompt is created. When run with the -s
option, the command prompts for a password, and the existing account
with username given by account has its password changed to the new one
entered. When run with the -d option, the account with username given
by account is removed from the database.
Whenever the cypasswd 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.
AUTHOR
Written by Alistair Riddoch.
REPORTING BUGS
Report bugs to <general@worldforge.org>.
COPYRIGHT
Copyright 2004 Alistair Riddoch.
SEE ALSO
cyphesis(1), cyclient(1), cycmd(1)
22 October 2006 CYPHESIS-TOOLS(1)