ikiwiki - Интернет в облаке

ПРОГРАММА:

ИМЯ

ikiwiki - компилятор вики

СИНТАКСИС

ikiwiki [параметры] исходный пункт назначения

ikiwiki --setup setupfile [параметры]

ОПИСАНИЕ

ikiwiki - это компилятор вики. Он создает статические HTML-страницы для вики из исходного кода в
ikiwiki / Markdown language (или другие) и записывает его по назначению.

Обратите внимание, что большинство параметров можно сократить до отдельных букв, логических флагов, таких как --verbose
может быть отменено с помощью --no-verbose, а такие параметры, как --verbose, также могут быть записаны как
-подробный.

РЕЖИМ ДОПОЛНИТЕЛЬНЫЕ УСЛУГИ, НЕ ВКЛЮЧЕННЫЕ В ПАКЕТ

Эти параметры управляют режимом работы ikiwiki.

- обновить
Обновите вики, обновив все измененные страницы. Это поведение по умолчанию, если нет
указано другое действие режима (но обратите внимание, что --setup является действием режима и имеет
другое поведение по умолчанию).

- перестроить
Принудительно перестроить все страницы.

--setup установочный файл
Загрузите параметры из данного установочного файла. Если никакое другое действие режима не указано,
сгенерируйте оболочки и перестройте вики, как если бы использовались --rebuild --wrappers. Если
если вы хотите создавать только какие-либо измененные страницы, вы можете использовать --refresh с --setup.

--changesetup файл настройки
Читает файл установки, добавляет любые изменения конфигурации, указанные другими параметрами,
и записывает новую конфигурацию обратно в установочный файл. Также обновляет любые
настроенные обертки. В этом режиме вики не полностью перестраивается, если вы также
добавить --rebuild.

Пример, чтобы включить некоторые плагины:

икивики --changesetup ~ / ikiwiki.setup --плагин goodstuff --плагин календарь

--dumpsetup файл настройки
Заставляет ikiwiki писать в указанный установочный файл, выгружая его текущий
конфигурации.

- обертки
Если используется с --setup --refresh, он также обновляет любые настроенные оболочки.

--чистый
Это заставляет ikiwiki очищаться, удаляя все файлы, созданные в месте назначения.
каталог, а также любые настроенные оболочки и каталог состояний .ikiwiki.
Это в основном полезно, если вы запускаете ikiwiki в Makefile для сборки
документацию и хотите соответствующую чистую цель.

--cgi Включить режим CGI. В режиме cgi ikiwiki работает как сценарий cgi и поддерживает редактирование.
страницы, вход в систему и регистрация.

Чтобы использовать ikiwiki в качестве программы CGI, вам необходимо использовать --wrapper или --setup для создания
обертка. Обертке обычно необходимо запустить suid 6755 для пользователя, владеющего
исходный и целевой каталоги.

--wrapper [файл]
Создайте двоичный файл оболочки, который жестко запрограммирован для выполнения действий, указанных другим
параметры, используя указанные входные файлы и целевой каталог. Имя файла для
использование обертки необязательно.

Оболочка предназначена для безопасного выполнения suid и запуска ненадежными пользователями в качестве
post-commit, или как CGI.

Обратите внимание, что созданная оболочка игнорирует все параметры командной строки.

- агрегировать
Если подключаемые модули / агрегатные подключаемые модули включены, это настраивает опрос ikiwiki.
питает и сохраняет новые сообщения в srcdir.

Обратите внимание, что для восстановления ранее собранных сообщений используйте параметр --rebuild вместе с
с этим. --rebuild также принудительно опрашивает каналы, даже если они были
опросил недавно.

--render файл
Визуализирует один файл, выводя полученный html. Не сохраняет состояние, поэтому это
нельзя использовать для создания целых вики, но это полезно для предварительного просмотра отредактированного
файл в командной строке. Обычно используется вместе с --setup для загрузки в
настройка вики:

ikiwiki - настройка ~ / ikiwiki.setup --рендерить foo.mdwn

--post-коммит
Запускается в режиме пост-фиксации, как если бы он был вызван обработчиком пост-фиксации. Это
вероятно, полезно только при использовании ikiwiki с веб-сервером на одном хосте и
репозиторий на другом, чтобы разрешить реальный хук репозитория после фиксации ssh для
хост веб-сервера и вручную запустить ikiwiki для обновления веб-сайта.

--версия
Выведите номер версии ikiwiki.

CONFIG ДОПОЛНИТЕЛЬНЫЕ УСЛУГИ, НЕ ВКЛЮЧЕННЫЕ В ПАКЕТ

Эти параметры настраивают вики. Обратите внимание, что плагины могут добавлять дополнительную конфигурацию
собственные варианты. Все эти параметры и многое другое также можно настроить с помощью
установочный файл.

--wikiname имя
Название вики, по умолчанию - «вики».

--templateir каталог
Укажите каталог, в котором хранятся шаблоны. По умолчанию
/ usr / share / ikiwiki / templates или другое расположение, настроенное во время сборки. Если
шаблонизменяется, отсутствующие шаблоны по-прежнему будут искать в
местоположение по умолчанию в качестве запасного варианта. Шаблоны также можно разместить в папке "templates /"
подкаталог srcdir.

Обратите внимание: если вы решите копировать и изменять шаблоны ikiwiki, вам потребуется
будьте осторожны, чтобы поддерживать их в актуальном состоянии при обновлении до новых версий ikiwiki. Старый
версии шаблонов не всегда работают с новыми версиями ikiwiki.

--underlaydir директор
Укажите каталог, который используется в качестве основы для исходного каталога. Исходные файлы
будут взяты отсюда, если они не будут переопределены файлом в исходном каталоге.
По умолчанию это / usr / share / ikiwiki / basewiki или другое местоположение, настроенное при сборке.
времени.

--wrappermode режим
Укажите режим изменения оболочки после ее создания.

--wrappergroup группа
Укажите, какой unix-группе должна принадлежать оболочка. Это может быть полезно, если
wrapper должен принадлежать другой группе, кроме группы по умолчанию. Например, если
В проекте есть репозиторий с несколькими коммиттерами, доступ которых контролируется
group, оболочкам ikiwiki имеет смысл запускать setgid для этой группы.

--rcs = svn | git | .., --no-rcs
Включить или отключить использование revision_control_system.

Предполагается, что исходный каталог является рабочей копией, или клоном, или чем-то еще.
используется выбранная вами система контроля версий.

В режиме CGI с включенной системой контроля версий страницы, редактируемые через Интернет, будут
быть совершенным.

По умолчанию контроль версий не включен.

--svnrepo / svn / вики
Укажите расположение репозитория svn для вики.

--svnpath ствол
Укажите путь внутри вашего svn-репозитория, где находится вики. Этот
по умолчанию используется ствол; измените его, если ваша вики находится на другом пути внутри
репозиторий. Если ваша вики находится в верхней части репозитория, установите svnpath на "".

--rss, --норсс
Если установлен rss, ikiwiki по умолчанию будет генерировать RSS-каналы для страниц со встроенным
блог.

- разрешить
Если allowrss установлен, а rss не установлен, ikiwiki не будет по умолчанию генерировать RSS.
каналов, но установка rss = yes во встроенной директиве может переопределить это значение по умолчанию и
создать фид.

-атом, -ноатом
Если задан атом, ikiwiki по умолчанию будет генерировать фиды Atom для страниц, которые встроены
блог.

--алловатом
Если параметр allowatom установлен, а rss не установлен, ikiwiki не будет по умолчанию генерировать
Atom подает, но установка atom = yes во встроенной директиве может переопределить это значение по умолчанию.
и сгенерируйте фид.

--пингурл URL
Установите для этого URL-адрес службы XML-RPC для проверки связи при обновлении RSS-канала. Для
Например, чтобы проверить связь с Technorati, используйте URL-адрес http://rpc.technorati.com/rpc/ping

Этот параметр можно указывать несколько раз, чтобы указать более одного URL-адреса для
пинг.

--URL-адрес
Задает URL-адрес вики. Это обязательный параметр в режиме CGI.

--cgiurl http://example.org/ikiwiki.cgi
Задает URL-адрес оболочки сценария ikiwiki CGI. Требуется при построении
wiki для создания ссылок на cgi-скрипт.

--historyurl URL-адрес
Задает URL-адрес для ссылки для просмотра истории страниц. В URL "[[файл]]" стоит
заменяется файлом для просмотра. Для этого обычно используют ViewVC.

--adminemail [электронная почта защищена]
Задает адрес электронной почты, который ikiwiki должен использовать для отправки электронной почты.

--diffurl URL-адрес
Задает URL-адрес, на который нужно ссылаться для просмотра изменений на странице. В URL-адресе
«[[файл]]» заменяется файлом для просмотра, «[[r1]]» - это старая версия
страница, а «[[r2]]» - это новая редакция. Для этого обычно используют ViewVC.

- исключить регулярное выражение
Задает rexexp исходных файлов, исключаемых из обработки. Может быть уточнено
несколько раз, чтобы добавить в список исключений.

--включить регулярное выражение
Определяет rexexp исходных файлов, которые обычно исключаются, но которые вы
хочу включить в обработку. Может быть указано несколько раз, чтобы добавить для включения
.

- имя администратора
Задает имя пользователя (или, если openid включен, openid), у которого есть
полномочия администратора вики. В настоящее время позволяет блокировать любую страницу и запрещать пользователям, как
а также полномочия, предоставляемые включенными плагинами (такими как [[модерирование
комментарии | плагины / модерированные комментарии]] и плагины / websetup. Может быть уточнено
несколько раз для нескольких администраторов.

Для пользователя openid укажите полный URL-адрес входа, включая «http: //».

- имя плагина
Позволяет использовать указанный плагин в вики. Обратите внимание, что названия плагинов
деликатный случай.

--disable-plugin имя
Отключает использование плагина. Например, "--disable-plugin htmlscrubber", чтобы убрать
с очисткой HTML.

--libdir каталог
Заставляет ikiwiki сначала искать в указанном каталоге, а не в обычных местах.
при загрузке файлов библиотеки и плагинов. Например, если вы установите libdir на
"/home/you/.ikiwiki/", вы можете установить плагин foo.pm как
"/home/you/.ikiwiki/IkiWiki/Plugin/foo.pm".

--дискуссия, --без обсуждения
Разрешает или запрещает добавление ссылок "Обсуждение" в заголовок каждого
страница. Ссылки включены по умолчанию.

--numbacklinks н
Управляет количеством обратных ссылок, отображаемых внизу страницы. Избыток
обратные ссылки будут скрыты во всплывающем окне. По умолчанию 10. Установите значение 0, чтобы отключить это.
функцию.

--userdir подкаталог
По желанию, позволяет ссылкам на пользователей вики ссылаться на страницы внутри
подкаталог вики. По умолчанию ссылки на страницы в каталоге верхнего уровня.
вики.

--htmlрасширить html
Настраивает расширение, используемое для сгенерированных файлов HTML. По умолчанию - «html».

- формат времени
Укажите, как отображать время или дату. Строка формата передается в
стрфтайм(3) функция.

--подробно, --не-подробно
Подробно рассказывайте о том, что делается.

--syslog, --no-syslog
Войти в системный журнал(3).

--useirs, --no-usedirs
Включите создание выходных файлов с именем page / index.html (по умолчанию) вместо page.html.

--prefix-директивы, --no-prefix-директивы
Включить новый синтаксис с префиксом '!' Для директив препроцессора. ikiwiki в настоящее время
по умолчанию --prefix-directives.

--w3mmode, --no-w3mmode
Включите w3mmode, который позволяет w3m использовать ikiwiki как локальный сценарий CGI без
веб сервер.

--sslcookie
Отправляйте файлы cookie только через SSL-соединение. Это должно помешать им
перехвачено. Если вы включите эту опцию, вы должны запустить хотя бы часть CGI.
ikiwiki через SSL.

--gettime, --no-gettime
Извлечь время создания и модификации для каждой новой страницы из ревизии
журнал управления. Это делается автоматически при первом создании вики,
поэтому обычно вам не нужно использовать эту опцию.

--set var = значение
Это позволяет установить произвольную переменную конфигурации, как если бы она была установлена
через установочный файл. Поскольку наиболее часто используемые параметры можно настроить с помощью
параметры командной строки, вам редко понадобится это использовать.

--set-yaml var = значение
Это похоже на --set, но позволяет устанавливать переменные конфигурации, использующие сложные
структуры данных, передавая документ YAML.

ПРИМЕРЫ

ikiwiki --setup my.setup

Полностью (заново) создайте вики, используя указанный установочный файл.

ikiwiki --setup my.setup --refresh
Обновите вики, используя настройки из my.setup, и избегайте восстановления любых страниц, которые
не изменились. Это быстрее.

ikiwiki --setup my.setup --refresh --wrappers
Обновите вики, включая регенерацию всех программ-оболочек, но не перестраивайте
все страницы. Полезно, если вы изменили что-то в установочном файле, что не
требуется полная перестройка вики, чтобы обновить все страницы, но вы хотите немедленно выполнить
Эффект.

ikiwiki --перестроить srcdir destdir
Используйте srcdir в качестве источника и создайте HTML в destdir без использования установочного файла.

ikiwiki srcdir целевая папка
Используйте srcdir в качестве источника для обновления HTML измененных страниц в destdir, не используя
установочный файл.

ОКРУЖАЮЩАЯ СРЕДА

CC

Это контролирует, какой компилятор C используется для создания оболочек. По умолчанию «cc».

CFLAGS. Его можно использовать для передачи параметров компилятору C при построении оболочек.

Используйте ikiwiki в Интернете с помощью сервисов onworks.net