~ubuntu-branches/ubuntu/natty/moin/natty-updates

The `moin` command is installed when you used `setup.py`. If invoking from the shell prompt does not find the `moin` command, you can also customize and use `wiki/server/moin`. Look into that script, there are some pathes to configure.

E.g. if you only have one wiki or one wiki farm on your machine and you configure `sys.path` in the `moin` command script, you do not need to give `--config-dir=...` option with every invocation.

You can also setup logging there if you don't like the builtin logging configuration.

{{{

usage: moin [command] [general options] command subcommand [specific options]

options:

--version show program's version number and exit

-h, --help show this help message and exit

-q, --quiet Be quiet (no informational messages)

--show-timing Show timing values [default: False]

--config-dir=DIR Path to the directory containing the wiki configuration

files. [default: current directory]

--wiki-url=WIKIURL URL of a single wiki to migrate e.g. localhost/mywiki/

[default: CLI]

--page=PAGE wiki page name [default: all pages]

moin ... account check ...

moin ... account create ...

moin ... account disable ...

moin ... account resetpw ...

moin ... cli show ...

moin ... export dump ...

moin ... export package ...

moin ... import irclog ...

moin ... index build ...

moin ... maint cleancache ...

moin ... maint cleanpage ...

moin ... maint globaledit ...

moin ... maint mailtranslators

moin ... maint makecache ...

moin ... maint mkpagepacks ...

moin ... maint reducewiki ...

moin ... migration data ...

moin ... xmlrpc mailimport ...

moin ... xmlrpc remote ...

General options:

Most commands need some general parameters before command subcommand:

--config-dir=/config/directory

Mandatory for most commands and specifies the directory that contains

your wikiconfig.py (or farmconfig.py).

--wiki-url=wiki.example.org/

Mandatory for most commands and specifies the url of the wiki you like

to operate on.

Specific options:

Most commands need additional parameters after command subcommand.

Sorry, but there is not much docs about that stuff yet, you can check

docs/CHANGES and the MoinMoin wiki site for more infos (or just try to

invoke some command/subcommand to see if it emits more help).

The code you invoke is contained in MoinMoin/script/command/subcommand.py,

so just reading the comments / source there might help you, too.

}}}

example for a default instance

{{{

moin --config-dir=/usr/share/moin/mywiki --wiki-url=http://webserver/mywiki migration data

}}}

== moin ... account check ... ==

{{{

--usersunique Makes user names unique (by appending the ID to name and

email, disabling subscribed pages and disabling all, but

the latest saved user account); default is to SHOW what

will be happening, you need to give the --save option to

really do it.

--emailsunique Makes user emails unique; default is to show, use --save

to save it.

--wikinames Convert user account names to wikinames (camel-case).

--lastsaved Normally the account most recently USED will survive and

the others will be disabled. Using --lastsaved, the

account most recently SAVED will survive.

--save If specified as LAST option, will allow the other

100

options to save user accounts back to disk. If not

101

specified, no settings will be changed permanently.

102

--removepasswords Remove pre-1.1 cleartext passwords from accounts.

103

}}}

104

105

== moin ... account create ... ==

106

{{{

107

--name=NAME Set the wiki user name to NAME.

108

--alias=ALIAS Set the wiki user alias name to ALIAS (e.g. the real

109

name if NAME is cryptic).

110

--email=EMAIL Set the user's email address to EMAIL.

111

--password=PASSWORD Set the user's password to PASSWORD (either cleartext

112

or {SHA1}...).

113

}}}

114

== moin ... account disable ... ==

115

{{{

116

--uid=UID Disable the user with user id UID.

117

--name=NAME Disable the user with user name NAME.

118

}}}

119

120

== moin ... account resetpw ... ==

121

{{{

122

--uid=UID Reset the password of the user with user id UID to the given password

123

--name=NAME Reset the password of the user with user name to the given password

124

}}}

125

126

== moin ... cli show ... ==

127

128

== moin ... export dump ... ==

129

{{{

130

--target-dir=/your/output/path to specify the directory we write the html files to

131

--username=name of the user to perform the dump with

132

}}}

133

134

== moin ... export package ... ==

135

{{{

136

-p PAGES, --pages=PAGES

137

Comma seperated list of pages to package.

138

-o OUTPUT, --output=OUTPUT

139

Output file for the package.

140

-s SEARCH, --search=SEARCH

141

Search string to match.

142

-u PACKAGE_USER, --user=PACKAGE_USER

143

User as whom the package operation will be performed

144

as.

145

}}}

146

To package all user created pages, do not specify --pages or --search.

147

148

== moin ... import irclog ... ==

149

may be you need a dir with ircfiles

150

151

== moin ... index build ... ==

152

it's for building the xapian search index. crashs if xapian isn't installed

153

154

== moin ... maint cleancache ... ==

155

removes cache files

156

157

== moin ... maint cleanpage ... ==

158

create a Linux shell script that can be used (after reviewing it) to clean up in the data_dir.

159

160

It tries to classify the page directories into classes like trash and deleted and it will move those page dirs from their usual place to 2 directories (you have to create them!) trash and deleted.

161

162

== moin ... maint globaledit ... ==

163

This is primarily for moin development use for globally editing pages in a wiki (we use it for streamlining ACLs and metadata on the master wiki). If you like to use it, please read the sourcecode first.

164

165

== moin ... maint mailtranslators ... ==

166

For moin development use only (mails the translators to notify them e.g. about a new release).

167

168

== moin ... maint makecache ... ==

169

creates cache files based on event-log and pagelinks

170

171

== moin ... maint mkpagepacks ... ==

172

NEVER EVER RUN THIS ON A REAL WIKI!!! This must be run on a local testwiki

173

174

== moin ... maint reducewiki ... ==

175

{{{

176

moin --config-dir=/usr/share/moin/mywiki --wiki-url=localhost/mywiki maint reducewiki --target-dir=/tmp/target

177

}}}

178

== moin ... migration data ... ==

179

migrates data of pages to a newer version

180

{{{

181

moin --config-dir=/usr/share/moin/mywiki --wiki-url=http://wikiserver/mywiki migration data

182

}}}

183

== moin ... server standalone ... ==

184

Starts the standalone server (and offers more options that just using ./wikiserver.py).

185

{{{

186

# See there for more infos:

187

moin server standalone --help

188

}}}

189

== moin ... xmlrpc mailimport ... ==

190

e.g.

191

{{{

192

# This is the configuration file for the mail import client

193

194

# This secret has to be known by the wiki server

195

mail_import_secret = u"foo"

196

197

# The target wiki URL

198

mail_import_url = u"http://localhost/?action=xmlrpc2"

199

}}}

200

201

== moin ... xmlrpc remote ... ==

202

needs a remotescriptconf.py

Older »