'\" t .\" ** The above line should force tbl to be a preprocessor ** .\" .\" Copyright (C) 2010 Frank Lin PIAT .\" .\" Manpage for moin .\" .\" You may distribute under the terms of the GNU General Public .\" License v2 or later (/usr/share/common-licenses/GPL) .\" .\" Tue Apr 6 19:08:39 CEST 2010 Frank Lin PIAT .\" .TH MOIN "1" "2010-04-06" "moin" "User Commands" .\" .\" ----------------------------------------------------------------- .\" * set default formatting .\" ----------------------------------------------------------------- .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) .ad l .\" .\" ----------------------------------------------------------------- .\" * MAIN CONTENT STARTS HERE * .\" ----------------------------------------------------------------- .SH NAME moin \- Moinmoin wiki management command-line interface .SH SYNOPSIS .\" The general command line .B moin [\fIgeneral options\fR] [\fIcommand\fR \fIcommand-subcommand\fR] [\fIspecific options\fR] .br .B moin [\-\-help|\-\-version] .SH DESCRIPTION \fBmoin\fR is a tool to interact with moinmoin wiki from the command line. The command can manipulate moinmoin user accounts, print/dump data, import irclogs, do maintenance task, etc. This command should be executed under the operating system account that "own" the wiki content (files). .SH OPTIONS .TP \fB\-\-config\-dir\fR=\fIDIR\fR Path to the directory containing the wiki configuration files. [default: current directory] (Debian's /usr/bin/moin defaults to /etc/moin/) .TP \fB\-\-wiki\-url\fR=\fIWIKIURL\fR URL of a single wiki to migrate e.g. http://localhost/mywiki/ [default: CLI] .TP \fB\-\-page\fR=\fIPAGE\fR wiki page name [default: all pages] .TP \fB\-\-version\fR show program's version number and exit .TP \fB\-q\fR, \fB\-\-quiet\fR Be quiet (no informational messages) .TP \fB\-\-show\-timing\fR Show timing values [default: False] .SH MOIN COMMANDS \fBmoin\fR command supports many commands, which in turns have sub-commands. .\" TAG:INSERT_GENENERATED_START .sp .TP \fBaccount\fR \fBcheck\fR \fB\-\-help\fR \fB[check-option]\fR When using ACLs, a wiki user name has to be unique, there must not be multiple accounts having the same username. The problem is, that this was possible before the introduction of ACLs and many users, who forgot their ID, simply created a new ID using the same user name. Because access rights (when using ACLs) depend on the NAME (not the ID), this must be cleaned up before using ACLs or users will have difficulties changing settings and saving their account data (system won't accept the save, if the user name and email is not unique). .sp .TP \fBaccount\fR \fBcreate\fR \fB\-\-help\fR \fB[create-option]\fR This tool allows you to create user accounts via a command line interface. .sp .TP \fBaccount\fR \fBdisable\fR \fB\-\-help\fR \fB[disable-option]\fR This tool allows you to disable user accounts via a command line interface. .sp .TP \fBaccount\fR \fBhomepage\fR \fB\-\-help\fR \fB[homepage-option]\fR This tool allows you to create user homepages via a command line interface. .sp .TP \fBaccount\fR \fBresetpw\fR \fB\-\-help\fR \fB[resetpw-option]\fR This tool allows you to change a user password via a command line interface. .sp .TP \fBcli\fR \fBshow\fR \fB\-\-help\fR \fB[show-option]\fR Just run a CLI request and show the output. .sp .TP \fBexport\fR \fBdump\fR \fB\-\-help\fR \fB[dump-option]\fR This tool allows you to dump MoinMoin wiki pages to static HTML files. .sp .TP \fBexport\fR \fBpackage\fR \fB\-\-help\fR \fB[package-option]\fR This tool allows you to create a package of certain wiki pages. .sp .TP \fBimport\fR \fBirclog\fR \fB\-\-help\fR \fB[irclog-option]\fR This script pushes files from a directory into the wiki (to be exact: it pushes all except the last file, as this is maybe still written to in case of irc logs). One application is to use it to store IRC logs into the wiki. .sp .TP \fBimport\fR \fBwikipage\fR \fB\-\-help\fR \fB[wikipage-option]\fR .sp .TP \fBindex\fR \fBbuild\fR \fB\-\-help\fR \fB[build-option]\fR This tool allows you to control xapian's index of Moin. .sp .TP \fBmaint\fR \fBcleancache\fR \fB\-\-help\fR \fB[cleancache-option]\fR This script allows you to globally delete all the cache files in data/pages/PageName/cache/ and /data/cache directories You will usually do this after changing MoinMoin code, by either upgrading version, installing or removing macros or changing the regex expression for dicts or groups. This often makes the text_html file invalid, so you have to remove it (the wiki will recreate it automatically). text_html is the name of the cache file used for compiled pages formatted by the wiki text to html formatter. .sp .TP \fBmaint\fR \fBcleanpage\fR \fB\-\-help\fR \fB[cleanpage-option]\fR This tool outputs a shell script which upon execution will remove unused or trashed pages from the wiki. .sp .TP \fBmaint\fR \fBcleansessions\fR \fB\-\-help\fR \fB[cleansessions-option]\fR This script allows you to clean up session files (usually used to maintain a "logged-in session" for http(s) or xmlrpc). .sp .TP \fBmaint\fR \fBglobaledit\fR \fB\-\-help\fR \fB[globaledit-option]\fR This tool allows you to edit all the pages in a wiki. .sp .TP \fBmaint\fR \fBmailtranslators\fR \fB\-\-help\fR \fB[mailtranslators-option]\fR This tool allows you to have a message read in from standard input, and then sent to all translators via email. If you use %(lang)s in the message it will be replaced with the appropriate language code for the translator. .sp .TP \fBmaint\fR \fBmakecache\fR \fB\-\-help\fR \fB[makecache-option]\fR This script allows you to create cache files in data/pages/PageName/cache/ and /data/cache directories You will usually do this after changing MoinMoin code and calling "maint cleancache", by either upgrading version, installing or removing macros. text_html is the name of the cache file used for compiled pages formatted by the wiki text to html formatter. .sp .TP \fBmaint\fR \fBmkpagepacks\fR \fB\-\-help\fR \fB[mkpagepacks-option]\fR This tool generates a set of packages from all the pages in a wiki. .sp .TP \fBmaint\fR \fBreducewiki\fR \fB\-\-help\fR \fB[reducewiki-option]\fR This tool allows you to reduce a data/ directory to just the latest page revision of each non-deleted page (plus all attachments). This is used to make the distributed underlay directory, but can also be used for other purposes. So we change like this: * data/pages/PageName/revisions/{1,2,3,4} -> data/pages/revisions/1 (with content of 4) * data/pages/PageName/current (pointing to e.g. 4) -> same (pointing to 1) * data/pages/PageName/edit-log and data/edit-log -> do not copy * data/pages/PageName/attachments/* -> just copy .sp .TP \fBmigration\fR \fBdata\fR \fB\-\-help\fR \fB[data-option]\fR This tool allow you to migrate data of pages to a newer version .sp .TP \fBserver\fR \fBstandalone\fR \fB\-\-help\fR \fB[standalone-option]\fR This tool allows you to start a standalone server .sp .TP \fBxmlrpc\fR \fBmailimport\fR \fB\-\-help\fR \fB[mailimport-option]\fR This tool allows you to import mail into the wiki. .sp .TP \fBxmlrpc\fR \fBremote\fR \fB\-\-help\fR \fB[remote-option]\fR This tool allows you to execute moin scripts remotely. .sp .TP \fBxmlrpc\fR \fBretrieve\fR \fB\-\-help\fR \fB[retrieve-option]\fR This tool allows you to print out the contents of a page via xmlrpc. .sp .TP \fBxmlrpc\fR \fBwrite\fR \fB\-\-help\fR \fB[write-option]\fR This tool allows you to edit a page with xmlrpc. It is more of a commented example than an actual script. .\" TAG:INSERT_GENENERATED_END .SH EXAMPLES .sp Clean the cache containing pre-computed/pre-rendered pages. .sp .RS 4 $ moin \-\-config\-dir=/etc/moin \-\-wiki\-url=http://webserver/mywiki maint cleancache .RE .sp Manually migrate the wiki content. .sp .RS 4 $ moin \-\-config\-dir=/where/your/configdir/is \-\-wiki\-url=http://webserver/mywiki migration data .RE .sp Create the initial Xapian index (after enabling it in the configuration file) .sp .RS 4 $ moin \-\-config-dir=/etc/moin \-\-wiki\-url=http://webserver/mywiki index build \-\-mode=add .RE .SH "SEE ALSO" The full documentation for moin command line is maintained as a Wiki page (HelpOnMoinCommand). A copy is available at /usr/share/doc/python-moinmoin/HelpOnMoinCommand. Read the help page on your running instance of moinmoin because other MoinMoin instances, like http://moinmo.in/HelpOnMoinCommand may run a different version. .\" .\" vim: ft=groff