1CYPHESIS-TOOLS(1) cyphesis CYPHESIS-TOOLS(1)
2
6 cyconfig, cyconvertrules, cydumprules, cyloadrules, cypasswd - cyphesis
7 tools
8
10 /usr/bin/cyaddrules [ --section:option=value ... ] [ rulesetname atlas-
11 xml-file ]
12 /usr/bin/cyconfig [ --section:option=value ... ]
15 /usr/bin/cyconvertrules rule_file
18 /usr/bin/cydumprules
21 /usr/bin/cyloadrules [ --section:option=value ... ] [ rulesetname
24 atlas-xml-file ]
25 /usr/bin/cypasswd [ { -a | -s | -d } account ]
28
31 The cyphesis tools manage the data and configuration files used by
32 cyphesis.
33 The cyaddrules tool uploads Atlas XML rules files into the a running
35 server. If rules already exist in the server, then the default
36 attributes are updated, and if the rule has a script associated with
37 it, then the script is reloaded from file. cyaddrules can either upload
38 the file given on the command line, or if none is specified it will
39 upload the rule file for the ruleset specified in the server config,
40 and any rule files it depends on. cyaddrules is typically used to add
41 additional rules during rule development without having to restart the
42 server. Rules can be loaded directly into a running server using cyad‐
43 drules.
44 The cyconfig program provides an easy scriptable way to make permanent
46 changes to the server config from the command line. It works by writ‐
47 ing new config options to .cyphesis.vconf in the users home directory,
48 which is read by the server at startup, and overrides the contents of
49 the main config file. For a description of the various options that the
50 server takes, please see cyphesis(1).
51 The cyconvertrules program converts Atlas XML rules files from an older
53 historic format into the format used by cyphesis since version 0.3.1.
54 The cydumprules program dumps rules from the database table used by the
56 server into a set of Atlas XML rules files. Note that this does not
57 produce a set of files containing the same rules as those that were
58 loaded in using cyloadrules because some of the rules in the rulesets
59 that were not top level may have been overloaded, and do not exist in
60 the database table. Typically this command will be used to get an
61 updated copy of the top level ruleset from the server database, and the
62 rest of the files will be ignored.
63 The cyloadrules tool loads Atlas XML rules files into the database ta‐
65 ble used by the server. The rules table is read by the server at
66 startup, so a server restart is typically required after loading rules.
67 cyloadrules can either load the file given on the command line, or if
68 none is specified it will load the rule file for the ruleset specified
69 in the server config, and any rule files it depends on. Rules can be
70 loaded directly into a running server using cyaddrules.
71 The cypasswd tool is used to administrate the accounts table in the
73 server database.
74
76 The cypasswd can either add a new account, set the password of an
77 existing account, or remove an account from the database. When no argu‐
78 ments are given, it prompts for a new admin password for cyphesis.
79 When run with the -a option, the command prompts for a password to be
80 entered and an account with the username given by account, and with the
81 password supplied at the prompt is created. When run with the -s
82 option, the command prompts for a password, and the existing account
83 with username given by account has its password changed to the new one
84 entered. When run with the -d option, the account with username given
85 by account is removed from the database.
86 Whenever the cypasswd prompts for a password, a second prompt is dis‐
88 played asking for confirmation of the password. If the two password
89 entered do not match, the operation is aborted, and no changes are made
90 to the database.
91
93 Written by Alistair Riddoch.
94
96 Report bugs to <general@worldforge.org>.
97
99 Copyright 2004 Alistair Riddoch.
100
102 cyphesis(1), cyclient(1), cycmd(1)
103 22 October 2006 CYPHESIS-TOOLS(1)