welcome: please sign in

The following 327 words could not be found in the dictionary of 7 words (including 7 LocalSpellingWords) and are highlighted below:
A1   about   account   accounts   action   additional   address   after   alias   all   allow   also   and   appending   are   as   back   based   Be   be   before   build   building   builtin   but   by   cache   camel   can   case   changed   check   classes   classify   clean   cleancache   cleanpage   cleartext   cli   code   Comma   command   commands   comments   config   configuration   configure   contained   containing   contains   Contents   Convert   crashs   create   created   creates   cryptic   current   customize   data   default   deleted   development   dir   directories   directory   dirs   Disable   disable   disabled   disabling   disk   do   docs   does   don   dump   editing   either   email   emails   emailsunique   emits   event   every   example   exit   export   False   farm   farmconfig   file   files   find   first   foo   For   for   from   General   general   give   given   globaledit   globally   happening   have   help   html   http   id   if   If   import   in   index   informational   infos   installed   instance   into   invocation   invoke   invoking   ircfiles   irclog   is   isn   it   It   just   lastsaved   latest   like   Linux   list   local   localhost   log   logging   Look   Ls   machine   mail   mailimport   mails   mailtranslators   maint   makecache   Makes   Mandatory   master   match   may   message   messages   metadata   might   migrate   migrates   migration   mkpagepacks   more   Most   most   move   much   must   mywiki   name   names   need   needs   new   newer   no   Normally   not   notify   number   Of   of   offers   on   one   only   operate   operation   option   options   or   org   other   others   output   Output   package   page   pagelinks   pages   parameters   password   passwords   Path   path   pathes   perform   performed   permanently   place   please   pre   primarily   program   prompt   py   quiet   read   reading   real   really   recently   reducewiki   release   remote   remotescriptconf   Remove   removepasswords   removes   Reset   resetpw   reviewing   run   save   saved   script   search   Search   secret   see   seperated   server   Set   settings   setup   share   shell   show   Show   single   site   so   some   Sorry   source   sourcecode   Specific   specific   specified   specifies   specify   standalone   Starts   streamlining   string   stuff   subcommand   subscribed   survive   sys   Table   target   testwiki   that   The   the   their   them   there   This   this   those   timing   tmp   to   To   too   translators   trash   tries   try   uid   unique   up   url   usage   use   used   User   user   username   usersunique   using   Using   usr   usual   values   version   we   webserver   what   when   whom   wiki   wikiconfig   wikinames   wikiserver   will   with   write   xapian   xmlrpc   xmlrpc2   yet   You   you   your  

Clear message
Page Locked

HelpOnMoinCommand

Contents

  1. moin
    1. moin ... account check ...
    2. moin ... account create ...
    3. moin ... account disable ...
    4. moin ... account resetpw ...
    5. moin ... cli show ...
    6. moin ... export dump ...
    7. moin ... export package ...
    8. moin ... import irclog ...
    9. moin ... index build ...
    10. moin ... maint cleancache ...
    11. moin ... maint cleanpage ...
    12. moin ... maint globaledit ...
    13. moin ... maint mailtranslators ...
    14. moin ... maint makecache ...
    15. moin ... maint mkpagepacks ...
    16. moin ... maint reducewiki ...
    17. moin ... migration data ...
    18. moin ... server standalone ...
    19. moin ... xmlrpc mailimport ...
    20. moin ... xmlrpc remote ...

1. moin

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

1.1. 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
                      options to save user accounts back to disk. If not
                      specified, no settings will be changed permanently.
  --removepasswords   Remove pre-1.1 cleartext passwords from accounts.

1.2. moin ... account create ...

  --name=NAME          Set the wiki user name to NAME.
  --alias=ALIAS        Set the wiki user alias name to ALIAS (e.g. the real
                       name if NAME is cryptic).
  --email=EMAIL        Set the user's email address to EMAIL.
  --password=PASSWORD  Set the user's password to PASSWORD (either cleartext
                       or {SHA1}...).

1.3. moin ... account disable ...

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

1.4. moin ... account resetpw ...

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

1.5. moin ... cli show ...

1.6. moin ... export dump ...

  --target-dir=/your/output/path to specify the directory we write the html files to
  --username=name of the user to perform the dump with

1.7. moin ... export package ...

  -p PAGES, --pages=PAGES
                        Comma seperated list of pages to package.
  -o OUTPUT, --output=OUTPUT
                        Output file for the package.
  -s SEARCH, --search=SEARCH
                        Search string to match.
  -u PACKAGE_USER, --user=PACKAGE_USER
                        User as whom the package operation will be performed
                        as.

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

1.8. moin ... import irclog ...

may be you need a dir with ircfiles

1.9. moin ... index build ...

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

1.10. moin ... maint cleancache ...

removes cache files

1.11. moin ... maint cleanpage ...

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

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.

1.12. moin ... maint globaledit ...

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.

1.13. moin ... maint mailtranslators ...

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

1.14. moin ... maint makecache ...

creates cache files based on event-log and pagelinks

1.15. moin ... maint mkpagepacks ...

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

1.16. moin ... maint reducewiki ...

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

1.17. moin ... migration data ...

migrates data of pages to a newer version 

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

1.18. moin ... server standalone ...

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

# See there for more infos:
moin server standalone --help

1.19. moin ... xmlrpc mailimport ...

e.g. 

# This is the configuration file for the mail import client

# This secret has to be known by the wiki server
mail_import_secret = u"foo"

# The target wiki URL
mail_import_url = u"http://localhost/?action=xmlrpc2"

1.20. moin ... xmlrpc remote ...

needs a remotescriptconf.py