1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244
|
Description: Backport missing man pages
Will not be needed after Cyphesis 0.6.2
Origin: https://github.com/worldforge/cyphesis/commit/bc7136eabf93c1b78fc48df7d465df4c7e1dd239
Last-Update: 2016-08-29
--- a/man/Makefile.am
+++ b/man/Makefile.am
@@ -1,5 +1,6 @@
man_MANS = cyclient.1 cycmd.1 cyphesis.1 cyphesis-tools.1 \
- cyaddrules.1 cyconvertrules.1 cydumprules.1 cyloadrules.1 cypasswd.1
+ cyaddrules.1 cyconvertrules.1 cydumprules.1 cyloadrules.1 cypasswd.1 \
+ cydb.1 cypython.1
.sgml.1:
docbook2man $(top_srcdir)/man/manpages.sgml
@@ -8,11 +9,13 @@
echo ".so man1/cyphesis-tools.1" > cydumprules.1
echo ".so man1/cyphesis-tools.1" > cyloadrules.1
echo ".so man1/cyphesis-tools.1" > cypasswd.1
+ echo ".so man1/cyphesis-tools.1" > cydb.1
+ echo ".so man1/cyphesis-tools.1" > cypython.1
EXTRA_DIST = cyclient.sgml cycmd.sgml cyphesis.sgml cyphesis-tools.sgml \
manpages.sgml cyclient.1 cycmd.1 cyphesis.1 cyphesis-tools.1 \
cyaddrules.1 cyconvertrules.1 cydumprules.1 cyloadrules.1 \
- cypasswd.1
+ cypasswd.1 cydb.1 cypython.1
maintainer-clean-local:
-rm -f $(man_MANS)
--- /dev/null
+++ b/man/cydb.1
@@ -0,0 +1 @@
+.so man1/cyphesis-tools.1
--- a/man/cyphesis-tools.1
+++ b/man/cyphesis-tools.1
@@ -1,31 +1,28 @@
-.\" This manpage has been automatically generated by docbook2man
-.\" from a DocBook document. This tool can be found at:
-.\" <http://shell.ipoline.com/~elmert/comp/docbook2X/>
-.\" Please send any bug reports, improvements, comments, patches,
-.\" etc. to Steve Cheng <steve@ggi-project.org>.
-.TH "CYPHESIS-TOOLS" "1" "18 November 2010" "" "cyphesis"
-
+.\" auto-generated by docbook2man-spec $Revision: 1.2 $
+.TH "CYPHESIS-TOOLS" "1" "17 April 2014" "" "cyphesis"
.SH NAME
-cyconfig, cyconvertrules, cydumprules, cyloadrules, cypasswd \- cyphesis tools
+cyconfig, cyconvertrules, cydumprules, cyloadrules, cypasswd, cypython, cydb \- cyphesis tools
.SH SYNOPSIS
-
-\fB/usr/bin/cyaddrules\fR [ \fB--section:option=value\fR\fI ...\fR ] [ \fBrulesetname atlas-xml-file\fR ]
-
-
-\fB/usr/bin/cyconfig\fR [ \fB--section:option=value\fR\fI ...\fR ]
-
-
+.sp
+\fB/usr/bin/cyaddrules\fR [ \fB--section:option=value\fR\fI...\fR ] [ \fBrulesetname atlas-xml-file\fR ]
+.sp
+\fB/usr/bin/cyconfig\fR [ \fB--section:option=value\fR\fI...\fR ]
+.sp
\fB/usr/bin/cyconvertrules\fR \fBrule_file\fR
-
-
+.sp
\fB/usr/bin/cydumprules\fR
-
-
-\fB/usr/bin/cyloadrules\fR [ \fB--section:option=value\fR\fI ...\fR ] [ \fBrulesetname atlas-xml-file\fR ]
-
-
-\fB/usr/bin/cypasswd\fR [ { \fB-a\fR | \fB-s\fR | \fB-d\fR } \fBaccount\fR ]
-
+.sp
+\fB/usr/bin/cyloadrules\fR [ \fB--section:option=value\fR\fI...\fR ] [ \fBrulesetname atlas-xml-file\fR ]
+.sp
+\fB/usr/bin/cypasswd\fR [ \fB -a -s -d account\fR ]
+.sp
+\fB/usr/bin/cyexport\fR \fBfilepath\fR
+.sp
+\fB/usr/bin/cyimport\fR \fBfilepath\fR
+.sp
+\fB/usr/bin/cypython\fR [ \fB--section:option=value\fR\fI...\fR ]
+.sp
+\fB/usr/bin/cydb\fR [ \fB--section:option=value\fR\fI...\fR ] \fBdataset\fR \fBaction\fR
.SH "DESCRIPTION"
.PP
The cyphesis tools manage the data and configuration files used by cyphesis.
@@ -38,7 +35,7 @@
will upload the rule file for the ruleset specified in the server config,
and any rule files it depends on. \fBcyaddrules\fR 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
+restart the server. Rules can be loaded directly into a running server
using \fBcyaddrules\fR\&.
.PP
The \fBcyconfig\fR program provides an easy scriptable way to
@@ -73,6 +70,36 @@
.PP
The \fBcypasswd\fR tool is used to administrate the accounts table
in the server database.
+.PP
+The \fBcyexport\fR 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 \fBcyimport\fR\&.
+.PP
+The \fBcyimport\fR tool imports entities and rules from a file,
+previously exported through the \fBcyexport\fR tool, into a
+running server.
+.PP
+The \fBcypython\fR 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.
+.PP
+The \fBcydb\fR 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:
+.TP
+\fBrules\fR
+Purge and list rules.
+.TP
+\fBuser\fR
+Purge, list, delete or modify user entries.
+.TP
+\fBuser\fR
+Purge the world of all entities.
+.PP
.SH "OPTIONS"
.PP
The \fBcypasswd\fR can either add a new account, set the password
@@ -83,22 +110,28 @@
and with the password supplied at the prompt is created. When run with the
\fB-s\fR option, the command prompts for a password, and the
existing account with username given by \fBaccount\fR has its password changed to
-the new one entered. When run with the \fB-d\fR option, the
+the new one entered. When run with the \fB-d\fR option, the
account with username given by \fBaccount\fR is removed from the database.
.PP
Whenever the \fBcypasswd\fR 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.
+.PP
+The \fBcyexport\fR by default only exports entities, but can also
+export rules through the option \fB--export:rules=1\fR\&.
+By default no transient entities are exported. This can be changed by the
+option \fB--export:transients=1\fR
.SH "AUTHOR"
.PP
-Written by Alistair Riddoch.
+Written by Alistair Riddoch and Erik Ogenvik.
.SH "REPORTING BUGS"
.PP
Report bugs to <general@worldforge.org>\&.
.SH "COPYRIGHT"
.PP
Copyright 2004 Alistair Riddoch.
+Copyright 2013 Erik Ogenvik.
.SH "SEE ALSO"
.PP
\fBcyphesis\fR(1),
--- a/man/cyphesis-tools.sgml
+++ b/man/cyphesis-tools.sgml
@@ -6,7 +6,7 @@
</refmeta>
<refnamediv>
- <refname>cyconfig, cyconvertrules, cydumprules, cyloadrules, cypasswd</refname>
+ <refname>cyconfig, cyconvertrules, cydumprules, cyloadrules, cypasswd, cypython, cydb</refname>
<refpurpose>cyphesis tools</refpurpose>
</refnamediv>
@@ -43,6 +43,16 @@
<arg choice="req">account</arg>
</group>
</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>
@@ -100,7 +110,44 @@
The <command>cypasswd</command> tool is used to administrate the accounts table
in the server database.
</para>
- </refsect1>
+ <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>
--- /dev/null
+++ b/man/cypython.1
@@ -0,0 +1 @@
+.so man6/cyphesis-tools.1
|