moin

Программа moin устанавливается при инсталляции дистрибутива МойнМойн посредством setup.py. В случае, если при вызове из командного интерпретатора программа moin не может быть найдена (это, вероятнее всего, означает то, что moin отсутствует в /usr/bin/ и не прописан в $PATH), можно также настроить и использовать wiki/server/moin (относительно пути установки экземпляра вики МойнМойн). Если посмотреть в этот скрипт, можно увидеть, что в нём присутствует ряд путей, которые необходимо указать.

Например, в случае использования всего одной вики или вики-фермы на машине и наличии настроенной переменной sys.path в скрипте moin, нет необходимости указывать параметр --config-dir=... при каждом вызове.

Также, в скрипте moin можно настроить опции протоколирования работы, в случае, если не устраивают настройки по умолчанию.

Использование:

moin [команда] [основные опции] команда подкоманда [опции, зависящие от команды]

Основные опции:

Параметр

Описание

--version

Показ информации о версии и завершение работы программы

-h, --help

Показ справочного сообщения и завершение работы программы

-q, --quiet

Не выводить информационных сообщений в процессе работы

--show-timing

Если у данного параметра указано значение True, показывать информацию о замере времени исполнения (по умолчанию отключено — False)

--config-dir=КАТАЛОГ

Каталог, содержащий файлы конфигурации вики (по умолчанию — текущий каталог).

--wiki-url=АДРЕС

Адрес экземпляра вики, например, localhost/mywiki/ (по умолчанию — ввод с командной строки)

--page=СТРАНИЦА

Имя страницы вики (по умолчанию — все страницы)

Список действий:

Действие

Субдействие

Описание

acсount

Действия над учётными записями

account

check

Различные служебные действия над учётными записями.

account

create

Создание новой учётной записи.

account

disable

Блокировка учётной записи

account

homepage

Данная команда позволяет создать домашние страницы пользователей посредством интерфейса командной строки.

account

resetpw

Сброс пароля для заданного пользователя.

cli

Командная строка

cli

show

Запуск командной строки moin

export

Экспортирование

export

dump

Создание html-версии всей или части вики.

export

package

Экспорт набора страниц в виде пакета.

import

Импорт

import

irclog

Импорт логов irc в формате irssi.

index

Действия над поисковым индексом Xapian

index

build

Построение и перестроение индекса Xapian.

maint

Операции по обслуживанию вики

maint

cleancache

Удаление файлов кэша.

maint

cleanpage

Создаёт shell-скрипт, который может использоваться (после его визуальной проверки) для очистки каталога data_dir.

maint

cleansession

Удаляет ненужные файлы сессий

maint

globaledit

Данная команда предназначена в основном для использования разработчиками МойнМойн для произведения глобальных правок на вики.

maint

mailtranslators

Используется только разработчиками МойнМойн (рассылка писем переводчикам для оповещения их о, например, новом релизе).

maint

makecache

Генерирует кэш на основании лога событий (evet-log) и ссылок на страницы.

maint

mkpagepacks

maint

reducewiki

migration

Миграция на новую версию

migration

data

Обновление данных вики до новой версии сервера.

xmlrpc

XML RPC

xmlrpc

mailimport

xmlrpc

remote

В комментариях на этой странице содержится вывод при вызове соответствующей команды с ключом --help.

Пример вызова:

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

moin ... account check ...

Различные служебные действия над учётными записями. Аргументы:

--userunique
Делает имена учётных записей уникальными (путём добавления ID к имени и почтовому адресу, отмены подписки на страницы и блокирования всех учтных записей, кроме последней сохранённой). По умолчанию показывает реультат действий, но не применяет их, необходимо добавить параметр --save для применения операции.
--emailsunique
Делает учётные записи уникальными. По умолчанию показывает эффект действия вместо его применения, для применения необходимо добавить опцию --save
--wikinames

Преобразует имена учётных записей в ВикиИмена.

--lastsaved
Если данная опция не используется, то незаблокированной оставляется последняя использованная учётная запись. Если данная опция используется, то не блокируется последняя сохранённая запись.
--save
Если данный аргумент указан последним, то эффект от указанных в предыдущих аргументах действий будет применятся, в противном случае эффект применения только выводится на экран.
--removepasswords

Удаление из файлов учётных записей паролей чистым текстом, использовавшихся в МойнМойн до версии 1.1

moin ... account create ...

Создание новой учётной записи.

--name=ИМЯ
установить имя учётной записи в ИМЯ
--alias=ПСЕВДОНИМ
задать псевдоним учётной записи (например, для случаев, когда ИМЯ генерируется искуственно)
--email=АДРЕС
задать почтовой адрес учётной записи
--password=ПАРОЛЬ
задать пароль учётной записи

moin ... account disable ...

Блокировка учётной записи.

--uid=ИДЕНТИФИКАТОР
Блокировать учётную запись с данным идентификатором.
--name=ИМЯ
Блокировать учётные записи с указанным именем.

moin ... account homepage ...

Данная команда позволяет создать домашние страницы пользователей посредством интерфейса командной строки.

--name=ИМЯ
Выбор учётной записи для создания домашней страницы по имени
--group=СтраницаГруппы
использует учётные записи для создания домашних страниц из страницы группыbhf
--all-users
Выбираются все пользователи
--user=ИМЯ
имя учётной записи пользоателя, от имени которого выполняется создание домашних страниц.
--template_page=ШаблонСтраницы
страница с шаблоном для страниц пользователей

moin ... account resetpw ...

Сброс пароля для заданного пользователя.

--uid=ИДЕНТИФИКАТОР
Сбросить пароль для учётной записи с данным идентификатором.
--name=ИМЯ
Сбросить пароль для учётной записи с указанным именем.

moin ... cli show ...

moin ... export dump ...

Создание html-версии всей или части вики.

--target-dir=/каталог/для/сохранения/
Путь к каталогу для сохранения создающихся файлов.
--username=АлександрПривалов
Имя пользователя, производящего создание html-версии

Дополнительная информация доступна на странице /ExportDump.

moin ... export package ...

Экспорт набора страниц в виде пакета.

-p СТРАНИЦЫ, --pages=СТРАНИЦЫ
Список страниц (разделённых запятыми), которые необходимо добавить в пакет.
-o ФАЙЛ, --output=ФАЙЛ
Имя файла генерируемого пакета.
-s ЗАПРОС, --search=ЗАПРОС
Поисковой запрос ,которому должны удовлетворять страницы.
-u ИМЯ, --user=ИМЯ
Пользователь, от имени которого выполняется операция.

Для запаковки всех страниц, созданным определённым пользователем, необходимо использовать только аргумент -u без указания аргументов -p или -s.

moin ... import irclog ...

may be you need a dir with ircfiles

moin ... import wikipage ...

Импортирование страницы из файла на вики.

moin ... index build ...

Построение поискового индекса Xapian. Завершает работу с ошибкой в случае, если Xapian не установлен.

Для начальной генерации индекса необходимо использовать следующую команду:

moin --config-dir=/каталог/с/файлами/конфигурации --wiki-url=адрес-вики/ index build --mode=add

Статус использования Xapian и состояние его индекса можно проверить на странице SystemInfo.

Кроме того, следующие параметры могут быть указаны для управления процессом построения индекса:

--mode=add
Элементы добавляются в индекс без предварительной проверки на их наличие в нём. Рекомендуется использовать только в случае отсутствия индекса.
--mode=rebuild
Перед добавлением всех элементов существующий индекс удаляется, если таковой существовал.
--mode=update
Обновляет страницы в индексе на основании времени их последнего изменения.

  • (!) Вызов --mode=update не требуется после каждого изменения страницы через интерфейс МойнМойн. Данный параметр предназначен только в отладочных целях и в случае, если страницы в индексе устарели.

    /!\ Индекс необходимо перестраивать (--mode=rebuild) после изменения хотябы одной из оций xapian_index_history, xapian_index_dir или xapian_stemming конфигурации.

moin ... maint cleancache ...

Удаление файлов кэша.

moin ... maint cleanpage ...

Создаёт shell-скрипт, который может использоваться (после его визуальной проверки) для очистки каталога data_dir (каталога, где хранится различная информация экземпляра вики).

Данная команда классифицирует каталоги страниц, выявляя удалённые страницы или мусор, и сгенерированный скрипт переместит эти каталоги из data_dir/pages в два катлога (которые должны быть предварительно созданы) --- trash (для страниц-мусора) и deleted (для удалённых страниц).

moin ... maint cleansessions ...

Данная команда позволяет удалять (ненужные) файлы сеансов (обычно используется для сопровождения авторизованных сеансов для http(s) и xmlrpc).

--name
Удалить сессии только для пользователя NAME (по умолчанию удаляются файлы сеансов для всех пользователей)
--all
Удалить все файлы сеансов (по умолчанию удаляются только просроченные файлы сеансов)

moin ... maint globaledit ...

Данная команда предназначена в основном для использования разработчиками МойнМойн для произведения глобальных правок на вики (например, оно используется для указания списков достуна и других метаданных на MoinMaster). Перед использованием макрокоманды (если таковое планируется), рекомендуется прочитать сначала её исходный код.

moin ... maint mailtranslators ...

Используется только разработчиками МойнМойн (рассылка писем переводчикам для оповещения их о, например, новом релизе).

moin ... maint makecache ...

Генерирует кэш на основании лога событий (evet-log) и ссылок на страницы.

moin ... maint mkpagepacks ...

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

moin ... maint reducewiki ...

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

moin ... migration data ...

Обновление данных вики до новой версии сервера.

Пример использования:

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

moin ... server standalone ...

Запуск вики-сервера (данная команда предоставляет больше параметров, чем ./wikiserver.py).

--version
Отображение версии вики-сервера и выход.
-q, --quiet
Отключение вывода информационных сообщений.
--show-timing

Печать информации о времени выполнения (по умолчанию имеет значение False — отключено).

--docs=КАТАЛОГ

Каталог со статическими документами. По умолчанию используется MoinMoin/web/static/htdocs.

--user=ПОЛЬЗОВАТЕЛЬ
Сменить пользователя, под которым выполняется процесс. Только в UNIX. По умолчанию пользователь не меняется.
--group=ГРУППА
Сменить группу, под которой выполняется процесс. Только в UNIX. По умолчанию группа не меняется.
--port=ПОРТ
Задать порт, который сервер должен слушать. Значение по умолчанию — 8080.
--hostname=ХОСТ, --interface=ИНТЕРФЕЙС

Задать имя хоста или IP, на котором открывать порт. Для прослушивания всех интерфейсов можно использовать пустое значение у --hostname или 0.0.0.0 для --interface. Значение по умолчанию — localhost.

--start
Запустить сервер на фоне.
--stop
Останоить сервер на фоне.
--pidfile=ФАЙЛ

Использовать указанный файл для хранения PID сервера. Значение по умолчанию — moin.pid.

--debug=РЕЖИМ
Режим отладочной печати сервера.

off — отладочная печать не производится (значение по умолчанию);

web — для отладки при помощи обозревателя;

external — для использования внешнего отладчика.

moin ... xmlrpc mailimport ...

Пример конфигурационного файла:

# 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"

Также см. КакНастраивать/ПоддержкаПочты.

moin ... xmlrpc remote ...

needs a remotescriptconf.py